OpenGL module

Author: LinusDierheimer

.github/workflows/pull_request.yml

@@ -13,7 +13,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: install required packages
-        run: sudo apt-get update && sudo apt-get install -y libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev
+        run: sudo apt-get update && sudo apt-get install -y libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev libgl-dev libegl-dev libglx-dev
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v1

.github/workflows/push.yml

@@ -16,7 +16,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: install required packages
-        run: sudo apt-get update && sudo apt-get install -y libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev
+        run: sudo apt-get update && sudo apt-get install -y libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev libgl-dev libegl-dev libglx-dev
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v1

CMakeLists.txt

@@ -33,6 +33,9 @@ OPTION(ENABLE_IMAGEMAGICK7 "Enable imagemagick 7" ON)
 OPTION(ENABLE_IMAGEMAGICK6 "Enable imagemagick 6" ON)
 OPTION(ENABLE_ZLIB "Enable zlib" ON)
 OPTION(ENABLE_CHAFA "Enable chafa" ON)
+OPTION(ENABLE_GL "Enable gl" ON)
+OPTION(ENABLE_EGL "Enable egl" ON)
+OPTION(ENABLE_GLX "Enable glx" ON)
 
 if(NOT CMAKE_BUILD_TYPE)
     set(CMAKE_BUILD_TYPE Release)
@@ -168,6 +171,7 @@ add_library(libfastfetch STATIC
     src/modules/date.c
     src/modules/time.c
     src/modules/colors.c
+    src/modules/opengl.c
 )
 
 if(ENABLE_LIBPCI)
@@ -343,7 +347,48 @@ if(ENABLE_CHAFA)
             message(WARNING "Package chafa>=1.10 not found. Building without support.")
         endif()
     else()
-        message(WARNING "Chafa not enabled, because neither ImageMagick6 nor ImageMagick7 is found. Building without support.")
+        message(WARNING "Chafa not enabled, because neither ImageMagick6 nor ImageMagick7 were found. Building without support.")
+    endif()
+endif()
+
+if(ENABLE_GL)
+    pkg_check_modules(GL gl)
+    if(NOT GL_FOUND)
+        message(WARNING "Package gl not found. Building without support.")
+    endif()
+endif()
+
+if(ENABLE_EGL)
+    if(GL_FOUND)
+        pkg_check_modules(EGL egl)
+        if(EGL_FOUND)
+            target_compile_definitions(libfastfetch PRIVATE FF_HAVE_EGL=1)
+        else()
+            message(WARNING "Package egl not found. Building without support.")
+        endif()
+    else()
+        message(WARNING "egl not enabled, because gl was not enabled or found. Building without support.")
+    endif()
+endif()
+
+if(ENABLE_GLX)
+    if(GL_FOUND)
+        pkg_check_modules(GLX glx)
+        if(GLX_FOUND)
+            target_compile_definitions(libfastfetch PRIVATE FF_HAVE_GLX=1)
+        else()
+            message(WARNING "Package glx not found. Building without support.")
+        endif()
+    else()
+        message(WARNING "glx not enabled, because gl was not enabled or found. Building without support")
+    endif()
+endif()
+
+if(GL_FOUND)
+    if(EGL_FOUND OR GLX_FOUND)
+        target_compile_definitions(libfastfetch PRIVATE FF_HAVE_GL=1)
+    else()
+        message(WARNING "gl not enabled, because neither egl nor glx were found. Building without support.")
     endif()
 endif()
 
@@ -368,6 +413,10 @@ target_include_directories(libfastfetch
     PRIVATE ${IMAGEMAGICK6_INCLUDE_DIRS}
     PRIVATE ${ZLIB_INCLUDE_DIRS}
     PRIVATE ${CHAFA_INCLUDE_DIRS}
+    PRIVATE ${VULKAN_INCLUDE_DIRS}
+    PRIVATE ${GL_INCLUDE_DIRS}
+    PRIVATE ${EGL_INCLUDE_DIRS}
+    PRIVATE ${GLX_INCLUDE_DIRS}
 )
 
 target_link_libraries(libfastfetch

README.md

@@ -32,6 +32,9 @@ The following libraries are used if present at runtime:
 *  [`libchafa`](https://github.com/hpjansson/chafa): Image output as ascii art.
 *  [`libZ`](https://www.zlib.net/): Faster image output when using kitty graphics protocol.
 *  [`libDBus`](https://www.freedesktop.org/wiki/Software/dbus): Needed for detecting current media player and song.
+*  [`libGL`](https://dri.freedesktop.org/wiki/libGL/):OpenGL module. At least one context creation library must be present too.
+*  [`libEGL`](https://www.khronos.org/registry/EGL/): OpenGL module, using EGL context.
+*  [`libGLX`](https://dri.freedesktop.org/wiki/GLX/): OpenGL module, using GLX context.
 *  [`libXFConf`](https://gitlab.xfce.org/xfce/xfconf): Needed for XFWM theme and XFCE Terminal font.
 *  [`libsqlite3`](https://www.sqlite.org/index.html): Needed for rpm package count.
 *  [`librpm`](http://rpm.org/): Slower fallback for rpm package count. Needed on openSUSE.

completions/bash

@@ -217,6 +217,7 @@ __fastfetch_completion()
         "--date-key"
         "--time-format"
         "--time-key"
+        "--gl"
     )
 
     local FF_OPTIONS_PATH=(
@@ -237,6 +238,9 @@ __fastfetch_completion()
         "--lib-imagemagick"
         "--lib-z"
         "--lib-chafa"
+        "--lib-gl"
+        "--lib-egl"
+        "--lib-glx"
         "--battery-dir"
         "--load-config"
     )

presets/all

@@ -1 +1 @@
---structure Title:Separator:OS:Host:Kernel:Uptime:Processes:Packages:Shell:Resolution:DE:WM:WMTheme:Theme:Icons:Font:Cursor:Terminal:TerminalFont:CPU:GPU:Memory:Disk:Battery:Player:Song:PublicIP:LocalIP:DateTime:Locale:Vulkan:Break:Colors
+--structure Title:Separator:OS:Host:Kernel:Uptime:Processes:Packages:Shell:Resolution:DE:WM:WMTheme:Theme:Icons:Font:Cursor:Terminal:TerminalFont:CPU:GPU:Memory:Disk:Battery:Player:Song:PublicIP:LocalIP:DateTime:Locale:Vulkan:OpenGL:Break:Colors

src/common/init.c

@@ -125,6 +125,7 @@ static void defaultConfig(FFinstance* instance)
     instance->config.disableLinewrap = true;
     instance->config.hideCursor = true;
     instance->config.escapeBedrock = true;
+    instance->config.glType = FF_GL_TYPE_AUTO;
 
     ffStrbufInitA(&instance->config.osFormat, 0);
     ffStrbufInitA(&instance->config.osKey, 0);
@@ -190,6 +191,8 @@ static void defaultConfig(FFinstance* instance)
     ffStrbufInitA(&instance->config.timeFormat, 0);
     ffStrbufInitA(&instance->config.vulkanKey, 0);
     ffStrbufInitA(&instance->config.vulkanFormat, 0);
+    ffStrbufInitA(&instance->config.openGLKey, 0);
+    ffStrbufInitA(&instance->config.openGLFormat, 0);
 
     ffStrbufInitA(&instance->config.libPCI, 0);
     ffStrbufInitA(&instance->config.libVulkan, 0);
@@ -207,6 +210,9 @@ static void defaultConfig(FFinstance* instance)
     ffStrbufInitA(&instance->config.libImageMagick, 0);
     ffStrbufInitA(&instance->config.libZ, 0);
     ffStrbufInitA(&instance->config.libChafa, 0);
+    ffStrbufInitA(&instance->config.libGL, 0);
+    ffStrbufInitA(&instance->config.libEGL, 0);
+    ffStrbufInitA(&instance->config.libGLX, 0);
 
     ffStrbufInitA(&instance->config.diskFolders, 0);
 
@@ -338,6 +344,15 @@ void ffListFeatures()
         #ifdef FF_HAVE_RPM
             "rpm\n"
         #endif
+        #ifdef FF_HAVE_GL
+            "gl\n"
+        #endif
+        #ifdef FF_HAVE_EGL
+            "egl\n"
+        #endif
+        #ifdef FF_HAVE_GLX
+            "glx\n"
+        #endif
         ""
     , stdout);
 }

src/data/config.txt

@@ -157,6 +157,12 @@
 # Default is true.
 #--escape-bedrock true
 
+# GL option
+# Sets with opengl context creation library to use
+# Must be either auto, egl or glx
+# Default is auto.
+#--gl auto
+
 # Key options:
 # Sets the displayed key of a module
 # Can be any string. Some of theme take an argument like a format string. See "fastfetch --help format" for help.
@@ -190,6 +196,7 @@
 #--song-key Song
 #--datetime-key Date Time
 #--vulkan-key Vulkan
+#--opengl-key OpenGL
 
 # Format options:
 # Sets the format string for module values.
@@ -226,6 +233,7 @@
 #--song-format
 #--datetime-format
 #--vulkan-format
+#--opengl-format
 
 # Library options:
 # Sets an user specific path to a library to load.
@@ -246,3 +254,6 @@
 #--lib-imagemagick /usr/lib/libMagickCore-7.Q16HDRI.so
 #--lib-z /usr/lib/libz.so
 #--lib-chafa /usr/lib/libchafa.so
+#--lib-gl /usr/lib/libGL.so
+#--lib-egl /usr/lib/libEGL.so
+#--lib-GLX /usr/lib/libGLX.so

src/data/help.txt

@@ -78,6 +78,7 @@ Format options: Provide the format string for custom output. Use fastfetch --hel
     --time-format <format>
     --date-format <format>
     --vulkan-format <format>
+    --opengl-format <format>
 
 Key options: Provide a custom key for an output
     --os-key <key>
@@ -112,6 +113,7 @@ Key options: Provide a custom key for an output
     --time-key <key>
     --date-key <key>
     --vulkan-key <key>
+    --opengl-key <key>
 
 Library options: Set the path of a library to load
     --lib-PCI <path>
@@ -130,6 +132,9 @@ Library options: Set the path of a library to load
     --lib-imagemagick <path>
     --lib-z <path>
     --lib-chafa <path>
+    --lib-gl <path>
+    --lib-egl <path>
+    --lib-glx <path>
 
 Module specific options:
     --separator-string <str>:     Set the string printed by the separator module
@@ -141,6 +146,7 @@ Module specific options:
     --localip-show-loop <?value>: Show loop back addresses (127.0.0.1) in local ip module. Default is false
     --public-ip-timeout:          Time in milliseconds to wait for the public ip server to respond. Default is disabled (0)
     --player-name:                The name of the player to use
+    --gl <value>:                 Sets the opengl context creation library to use. Must be auto, egl, or glx. Default is auto
 
 Parsing is not case sensitive. E.g. "--lib-PCI" is equal to "--Lib-Pci"
 If a value starts with a ?, it is optional. "true" will be used if not set.

src/data/modules.txt

@@ -17,6 +17,7 @@ Locale
 LocalIP
 Memory
 OS
+OpenGL
 Packages
 Player
 Processes