[MINOR] New cmd-line-arg + fix taglib addn prop issue + completions

Author: nots1dd

README.md

@@ -159,43 +159,56 @@ inLimbo --update-cache-run --print-song-tree # will create a new song map and pr
 
 Note that this will result in slower song map times as the song map is generated dynamically on each run.
 
----
-
 ## **Command-Line Arguments**
 
-### `--help`
+- `--help`
 **Description**: Display help information about available arguments for inLimbo.
 
-### `--version`
+- `--version`
 **Description**: Display the version number of inLimbo.
 
-### `--clear-cache`
+- `--clear-cache`
 **Description**: Clear cached data, which includes the song map and other temporary data stored by the application.
 
-### `--show-config-file`
+- `--show-config-file`
 **Description**: Display the path to the configuration file used by inLimbo.
 
-### `--show-log-dir`
+- `--show-log-dir`
 **Description**: Show the directory path where logs are stored for inLimbo.
 
-### `--show-dbus-name`
+- `--show-dbus-name`
 **Description**: Show the DBus service name used by inLimbo.
 
-### `--update-cache-run`
+- `--update-cache-run`
 **Description**: Update the cache file and run the application. This will make inLimbo load the directory dynamically every time (note that this will result in slower song map times).
 
-### `--print-song-tree`
+- `--print-song-tree`
 **Description**: Print the song map parsed from the directory. This shows the structure of the song tree and how songs are organized.
 
-### `--print-artists-all`
+- `--print-artists-all`
 **Description**: Print all parsed artists from the song map. This will list all artists found in the directory and their corresponding songs.
 
-### `--print-songs-by-artist`
+- `--print-songs-by-artist`
 **Description**: Print all the songs of a given artist. This argument requires you to specify the artist’s name, and it will list all songs by that artist.
 
-### `--print-songs-by-genre-all`
+- `--print-songs-by-genre-all`
 **Description**: Print all parsed genres and their song mappings. This will show all the genres available in the song map and list songs under each genre.
 
+- `--print-song-info`
+**Description**: Print every parsed information (even default info) regarding a song (Arguments: Can take **SONG NAME** or **FILE PATH**)
+
+> [!NOTE]
+> 
+> To utilize these arguments to the fullest, it is **HIGHLY** recommended to use something like `less`/`bat`
+> that allows for neat terminal output traversal (will allow for you to view the entire song tree parsing)
+> 
+> ```bash 
+> inLimbo --print-song-tree | bat # an example of using bat to view the song tree (can traverse the output easily)
+> ```
+> 
+> This ensures that you do not have any struggle with viewing the entire console output.
+> 
+
 There will be more command-line arguments in the future...
 
 ## **CONFIGURATION**
@@ -231,8 +244,6 @@ There is quite a lot to configure in the inLimbo project. A basic config file wi
 | `?` | **Show or hide the help menu** |
 | `/` | **Open the search menu** |
 
----
-
 ### **Scrolling and Selection**
 | Keybind | Action |
 |---------|--------|
@@ -241,8 +252,6 @@ There is quite a lot to configure in the inLimbo project. A basic config file wi
 | `0` | **Move to the next search result** (if search is active) |
 | `9` | **Move to the previous search result** (if search is active) |
 
----
-
 ### **Playback Controls**
 | Keybind | Action |
 |---------|--------|
@@ -253,8 +262,6 @@ There is quite a lot to configure in the inLimbo project. A basic config file wi
 | `r` | **Replay the current song** |
 | `m` | **Toggle mute** on/off |
 
----
-
 ### **Seeking and Volume Control**
 | Keybind | Action |
 |---------|--------|
@@ -264,8 +271,6 @@ There is quite a lot to configure in the inLimbo project. A basic config file wi
 | `-` | **Decrease volume** |
 | `w` | **Toggle between available audio devices** |
 
----
-
 ### **Song and Queue Management**
 | Keybind | Action |
 |---------|--------|
@@ -275,17 +280,13 @@ There is quite a lot to configure in the inLimbo project. A basic config file wi
 | `d` | **Remove the currently selected song from the queue** |
 | `3` | **View the current song queue** |
 
----
-
 ### **Song Information and UI Navigation**
 | Keybind | Action |
 |---------|--------|
 | `1` | **Go to the main UI screen** |
 | `2` or `L` | **View lyrics of the currently playing song** |
 | `i` | **View detailed information about the current song** |
 
----
-
 ### **Status Bar & UI Settings**
 | Keybind | Action |
 |---------|--------|

assets/completions/inLimbo-completions.bash

@@ -18,6 +18,7 @@ _inLimbo_completions() {
         "--print-artists-all        Print all parsed artists from Song Map"
         "--print-songs-by-artist    Print all the songs of a given artist"
         "--print-songs-by-genre-all Print all parsed genre and their song mappings"
+        "--print-song-info          Print every parsed field of a song name / filepath"
     )
 
     # Provide completion for options

assets/completions/inLimbo-completions.fish

@@ -11,7 +11,8 @@ function _inLimbo_completions
         "--print-song-tree"   "Print the Song Map parsed from directory" \
         "--print-artists-all"        "Print all parsed artists from Song Map" \
         "--print-songs-by-artist"    "Print all the songs of a given artist" \
-        "--print-songs-by-genre-all" "Print all parsed genre and their song mappings"
+        "--print-songs-by-genre-all" "Print all parsed genre and their song mappings" \
+        "--print-song-info"          "Print every parsed field of a song name / filepath"
     for i in (seq 1 2 (count $opts))
         set -l opt (string trim -- $opts[$i])
         set -l desc $opts[(math $i + 1)]

assets/completions/inLimbo-completions.zsh

@@ -12,6 +12,7 @@ _inLimbo_completions() {
         "--print-artists-all:Print all parsed artists from Song Map"
         "--print-songs-by-artist:Print all the songs of a given artist"
         "--print-songs-by-genre-all:Print all parsed genre and their song mappings"
+        "--print-song-info:Print every parsed field of a song name / filepath"
     )
     _describe -t options "inLimbo options" opts
 }

src/arg-handler.hpp

@@ -31,7 +31,9 @@ struct SongTreeState
   bool        printArtistsAll    = false;
   bool        printSongsByArtist = false;
   bool        printSongsGenreAll = false;
+  bool printSongInfo = false;
   std::string artist;
+  std::string song;
 };
 
 /**
@@ -129,7 +131,8 @@ class ArgumentHandler
       {"--print-artists-all", [&]() { handlePrintArtistsAll(); }},
       {"--print-songs-by-genre-all", [&]() { handlePrintSongsByGenreAll(); }},
       {"--print-songs-by-artist",
-       [&]() { handlePrintSongsByArtist(cmdArgs.get("--print-songs-by-artist")); }}};
+       [&]() { handlePrintSongsByArtist(cmdArgs.get("--print-songs-by-artist")); }},
+      {"--print-song-info", [&]() { handleSongInfo(cmdArgs.get("--print-song-info")); }}};
 
     for (const auto& [flag, handler] : argumentHandlers)
     {
@@ -163,6 +166,10 @@ class ArgumentHandler
     {
       song_tree.getSongsByGenreAndPrint();
     }
+    if (ArgumentHandler::song_tree_parse_state.printSongInfo)
+    {
+      song_tree.printSongInfo(ArgumentHandler::song_tree_parse_state.song);
+    }
   }
 
 private:
@@ -286,31 +293,39 @@ class ArgumentHandler
     shouldRunApp = true;
   }
 
+  static void parseSongMap()
+  {
+    parseSongTree = true;
+    shouldRunApp = true;
+  }
+
   static void handlePrintSongTree()
   {
-    parseSongTree                       = true;
     song_tree_parse_state.printSongTree = true;
-    shouldRunApp                        = true;
+    parseSongMap();
   }
 
   static void handlePrintArtistsAll()
   {
-    parseSongTree                         = true;
-    shouldRunApp                          = true;
+    parseSongMap();
     song_tree_parse_state.printArtistsAll = true;
   }
 
   static void handlePrintSongsByArtist(std::string artistName)
   {
-    parseSongTree                            = true;
-    shouldRunApp                             = true;
+    parseSongMap();
     song_tree_parse_state.printSongsByArtist = true;
     song_tree_parse_state.artist             = artistName;
   }
   static void handlePrintSongsByGenreAll()
   {
-    parseSongTree                            = true;
-    shouldRunApp                             = true;
+    parseSongMap();
     song_tree_parse_state.printSongsGenreAll = true;
   }
+  static void handleSongInfo(std::string songName)
+  {
+    parseSongMap();
+    song_tree_parse_state.printSongInfo = true;
+    song_tree_parse_state.song = songName;
+  }
 };

src/cmd-line-args.hpp

@@ -241,4 +241,5 @@ const std::vector<std::string> CommandLineArgs::validFlags = {"--help",
                                                               "--print-song-tree",
                                                               "--print-songs-by-artist",
                                                               "--print-songs-by-genre-all",
+                                                              "--print-song-info",
                                                               "--print-artists-all"};

src/dirsort/songmap.hpp

@@ -21,13 +21,15 @@
 #pragma once
 
 #include "taglib_parser.h"
+#include "../helpers/levenshtein.hpp"
 #include <cereal/archives/binary.hpp>
 #include <cereal/types/map.hpp>
 #include <cereal/types/string.hpp>
 #include <cereal/types/vector.hpp>
 #include <fstream>
 #include <iostream>
 #include <map>
+#include <optional>
 #include <set>
 #include <string>
 #include <vector>
@@ -381,4 +383,122 @@ class SongTree
     cereal::BinaryInputArchive archive(file);
     archive(*this); // Deserialize the SongTree
   }
+
+  /**
+   * @brief Prints metadata and additional properties of a song.
+   *
+   * This function retrieves a song based on either a file path or a song name
+   * and prints all relevant metadata, including title, artist, album, genre,
+   * track number, disc number, and inode.
+   *
+   * @param input The file path or song name to search for.
+   */
+  void printSongInfo(const std::string& input)
+  {
+    bool isFilePath = input.find('/') != std::string::npos || input.find('\\') != std::string::npos;
+
+    std::optional<Song> foundSong;
+
+    if (isFilePath)
+    {
+      // If input is a file path, retrieve its metadata using inode
+      std::cout << std::endl << "> Taking argument as a possible audio file path..." << std::endl;
+      struct stat fileStat;
+      if (stat(input.c_str(), &fileStat) == 0)
+      {
+        unsigned int inode = fileStat.st_ino;
+        for (const auto& artistPair : tree)
+        {
+          for (const auto& albumPair : artistPair.second)
+          {
+            for (const auto& discPair : albumPair.second)
+            {
+              for (const auto& trackPair : discPair.second)
+              {
+                if (trackPair.second.inode == inode)
+                {
+                  foundSong = trackPair.second;
+                  break;
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    else
+    {
+      // If input is a song name, search by title
+      for (const auto& artistPair : tree)
+      {
+        for (const auto& albumPair : artistPair.second)
+        {
+          for (const auto& discPair : albumPair.second)
+          {
+            for (const auto& trackPair : discPair.second)
+            {
+              if (levenshteinDistance(trackPair.second.metadata.title, input) < 3) // Recommended limit of correction (else it will go bonkers)
+              {
+                foundSong = trackPair.second;
+                break;
+              }
+            }
+          }
+        }
+      }
+    }
+
+    if (foundSong)
+    {
+      const auto& song = *foundSong;
+      std::cout << "\n🎵 Song Information:\n";
+      std::cout << "──────────────────────────────────────\n";
+      std::cout << "Title     : " << song.metadata.title << "\n";
+      std::cout << "Artist    : " << song.metadata.artist << "\n";
+      std::cout << "Album     : " << song.metadata.album << "\n";
+      std::cout << "Disc      : " << song.metadata.discNumber << "\n";
+      std::cout << "Track     : " << song.metadata.track << "\n";
+      std::cout << "Genre     : " << song.metadata.genre << "\n";
+      std::cout << "Inode     : " << song.inode << "\n";
+
+      if (!song.metadata.additionalProperties.empty())
+      {
+        std::cout << "Additional Properties:\n";
+        for (const auto& prop : song.metadata.additionalProperties)
+        {
+          if (prop.first == "LYRICS")
+          {
+            std::cout << "\n📜 Lyrics:\n";
+            std::cout << "──────────────────────────────────────\n";
+
+            // Wrap and format the lyrics
+            const std::string& lyrics = prop.second;
+            size_t lineLength = 80;
+            size_t start = 0;
+            while (start < lyrics.size())
+            {
+              size_t end = start + lineLength;
+              if (end > lyrics.size()) end = lyrics.size();
+              std::cout << lyrics.substr(start, end - start) << "\n";
+              start = end;
+            }
+            std::cout << "──────────────────────────────────────\n";
+          }
+          else
+          {
+            std::cout << "  - " << prop.first << " : " << prop.second << "\n";
+          }
+        }
+      }
+      else
+      {
+        std::cout << "No additional properties found!" << std::endl;
+      }
+      std::cout << "──────────────────────────────────────\n";
+    }
+    else
+    {
+      std::cout << "⚠️  Song not found: " << input << "\n";
+    }
+  }
 };

src/dirsort/taglib_parser.h

@@ -238,8 +238,8 @@ auto TagLibParser::parseFile(const std::string& filePath, Metadata& metadata) ->
   }
 
   // Populate additional properties if needed
-  if (debugLogBool && !properties.isEmpty()) {
-    std::cout << "[TAG PARSE] Additional properties found!" << std::endl;
+  if (!properties.isEmpty()) {
+    if (debugLogBool) std::cout << "[TAG PARSE] Additional properties found!" << std::endl;
     for (const auto& prop : properties) {
       std::string key = prop.first.to8Bit(true);
       std::string value = prop.second.toString().to8Bit(true);