modules/dwl: new module

doc/meson.build

@@ -6,7 +6,7 @@ scdoc_prog = find_program(scdoc.get_variable('scdoc'), native: true)
 foreach man_src : ['yambar.1.scd', 'yambar.5.scd', 'yambar-decorations.5.scd',
                    'yambar-modules-alsa.5.scd', 'yambar-modules-backlight.5.scd',
                    'yambar-modules-battery.5.scd', 'yambar-modules-clock.5.scd',
-                   'yambar-modules-disk-io.5.scd',
+                   'yambar-modules-disk-io.5.scd', 'yambar-modules-dwl.5.scd',
                    'yambar-modules-foreign-toplevel.5.scd',
                    'yambar-modules-i3.5.scd', 'yambar-modules-label.5.scd',
                    'yambar-modules-mpd.5.scd', 'yambar-modules-network.5.scd',

doc/yambar-modules-dwl.5.scd

@@ -0,0 +1,95 @@
+yambar-modules-dwl(5)
+
+# NAME
+dwl - This module provides information about dwl tags, and information.
+
+# DESCRIPTION
+
+This module provides a map of each tags present in dwl.
+
+Each tags has its _id_, its status (_selected_, _empty_, _urgent_)
+and the global data like _title_, _fullscreen_, _floating_,
+_selmon_, and _layout_). The tags start a 1. For needs where
+you only want information about the global data and not the _tags_,
+there is a tag with the id _0_ that contains only the global data.
+
+This module will track *only* the monitor where yambar was launched on.
+If you have a multi monitor setup, please launch yambar on each of your
+monitors.
+
+Please, be aware that only *one instance* of this module is supported.
+Running multiple instances at the same time may result in 
+*undefined behavior*.
+
+# TAGS
+
+[[ *Name*
+:[ *Type*
+:[ *Description*
+|  id
+:  int
+:  Dwl tag id.
+|  selected
+:  bool
+:  True if the tag is currently selected.
+|  empty
+:  bool
+:  True if there are no windows in the tag.
+|  urgent
+:  bool
+:  True if the tag has the urgent flag set.
+|  title
+:  string
+:  The currently focused window's title.
+|  fullscreen
+:  bool
+:  True if there is a fullscreen window in the current tag.
+|  floating
+:  bool
+:  True if there is a floating window in the current tag.
+|  selmon
+:  bool
+:  True if the monitor is actually focused.
+|  layout
+:  string
+:  The actual layout name of the tag.
+
+# CONFIGURATION
+
+[[ *Name*
+:[ *Type*
+:[ *Req*
+:[ *Description*
+|  number-of-tags
+:  int
+:  yes
+:  The number of defined tags in the dwl `config.def.h`.
+|  dwl-info-filename
+:  string
+:  yes
+:  The filepath to the log emitted by dwl when running.
+
+# EXAMPLES
+
+```
+bar:
+  left:
+    - dwl:
+        number-of-tags: 9
+        dwl-info-filename: "/home/ogromny/dwl_info"
+        content:
+          list:
+            items:
+              - map:
+                  conditions:
+                    selected: {string: {text: "-> {id}"}}
+                    ~empty: {string: {text: "{id}"}}
+                    urgent: {string: {text: "=> {id} <="}}
+                    # default tag
+                    id == 0: {string: {text: "{layout} {title}"}}
+```
+
+# SEE ALSO
+
+*yambar-modules*(5), *yambar-particles*(5), *yambar-tags*(5), *yambar-decorations*(5)
+