Added support for the '-S/--state' command-line option to filter processes by state.

This exposes the internal Process state character conversion function so it can be
reused for the filter string processing. Multiple characters are allowed for the filter
and a process is displayed if any of the provided state characters matches the
state of the process currently processed.

Co-authored-by: Allison <[email protected]>
Co-authored-by: BenBE <[email protected]>

Author: melrovieira

CommandLine.c

@@ -54,6 +54,7 @@ static void printHelpFlag(const char* name) {
           "-C --no-color                   Use a monochrome color scheme\n"
           "-d --delay=DELAY                Set the delay between updates, in tenths of seconds\n"
           "-F --filter=FILTER              Show only the commands matching the given filter\n"
+          "-S --state=STATESCHARS          Show only the states matching the given states\n"
           "-h --help                       Print this help screen\n"
           "-H --highlight-changes[=DELAY]  Highlight new and old processes\n", name);
 #ifdef HAVE_GETMOUSE
@@ -78,6 +79,7 @@ static void printHelpFlag(const char* name) {
 typedef struct CommandLineSettings_ {
    Hashtable* pidMatchList;
    char* commFilter;
+   char* stateFilter;
    uid_t userId;
    int sortKey;
    int delay;
@@ -98,6 +100,7 @@ static CommandLineStatus parseArguments(int argc, char** argv, CommandLineSettin
    *flags = (CommandLineSettings) {
       .pidMatchList = NULL,
       .commFilter = NULL,
+      .stateFilter = NULL,
       .userId = (uid_t)-1, // -1 is guaranteed to be an invalid uid_t (see setreuid(2))
       .sortKey = 0,
       .delay = -1,
@@ -128,6 +131,7 @@ static CommandLineStatus parseArguments(int argc, char** argv, CommandLineSettin
       {"tree",       no_argument,         0, 't'},
       {"pid",        required_argument,   0, 'p'},
       {"filter",     required_argument,   0, 'F'},
+      {"state",      required_argument,   0, 'S'},
       {"highlight-changes", optional_argument, 0, 'H'},
       {"readonly",   no_argument,         0, 128},
       PLATFORM_LONG_OPTIONS
@@ -136,7 +140,7 @@ static CommandLineStatus parseArguments(int argc, char** argv, CommandLineSettin
 
    int opt, opti = 0;
    /* Parse arguments */
-   while ((opt = getopt_long(argc, argv, "hVMCs:td:n:u::Up:F:H::", long_opts, &opti))) {
+   while ((opt = getopt_long(argc, argv, "hVMCs:td:n:u::Up:F:H::S:", long_opts, &opti))) {
       if (opt == EOF)
          break;
 
@@ -255,6 +259,41 @@ static CommandLineStatus parseArguments(int argc, char** argv, CommandLineSettin
             }
             free_and_xStrdup(&flags->commFilter, optarg);
             break;
+
+         case 'S':
+            //ensures that optarg is not NULL
+            assert(optarg);
+
+            // check if the argument is empty
+            if (optarg[0] == '\0') {
+               fprintf(stderr, "Error: state filter cannot be empty.\n");
+               return STATUS_ERROR_EXIT;
+            }
+
+            // for each character in optarg:
+            //   - check if it corresponds to a valid ProcessState enum value
+            //   - if any character is invalid, print an error and exit
+            for (char* c = optarg; *c != '\0'; c++) {
+               int valid = 0;
+
+               // test all ProcessState enum values
+               for (ProcessState s = UNKNOWN; s <= SLEEPING; s++) {
+                  if (*c == processStateChar(s)) {
+                     valid = 1;  // character is valid
+                     break;
+                  }
+               }
+
+               // if character is invalid, report error and exit
+               if (!valid) {
+                  fprintf(stderr, "Error: invalid state filter value \"%s\".\n", optarg);
+                  return STATUS_ERROR_EXIT;
+               }
+            }
+
+            free_and_xStrdup(&flags->stateFilter, optarg);
+            break;
+
          case 'H': {
             const char* delay = optarg;
             if (!delay && optind < argc && argv[optind] != NULL &&
@@ -382,6 +421,9 @@ int CommandLine_run(int argc, char** argv) {
       .hideSelection = false,
       .hideMeters = false,
    };
+   if (flags.stateFilter) {
+      free_and_xStrdup(&settings->stateFilter, flags.stateFilter);
+   }
 
    MainPanel_setState(panel, &state);
    if (flags.commFilter)

Process.c

@@ -536,7 +536,7 @@ void Process_writeCommand(const Process* this, int attr, int baseAttr, RichStrin
    }
 }
 
-static inline char processStateChar(ProcessState state) {
+char processStateChar(ProcessState state) {
    switch (state) {
       case UNKNOWN: return '?';
       case RUNNABLE: return 'U';
@@ -859,8 +859,16 @@ static bool Process_matchesFilter(const Process* this, const Table* table) {
    assert(Object_isA((const Object*) pt, (const ObjectClass*) &ProcessTable_class));
    if (pt->pidMatchList && !Hashtable_get(pt->pidMatchList, Process_getThreadGroup(this)))
       return true;
+   const char* stateFilter = host->settings->stateFilter;// stateFilter arguments passed by user
+   if (stateFilter) {
+      char stateChar = processStateChar(this->state); //stateChar of current process
+      if (!strchr(stateFilter, stateChar)) { //checks if stateChar exists in stateFilter arguments
+         return true; //if stateChar don't exists in string, return true, this hide the process that is not in stateFilter arguments
+      }
+   }
 
-   return false;
+
+   return false; //if stateChar exists in string, return false, for the process that user passed by in stateFilter arguments to appear
 }
 
 bool Process_rowMatchesFilter(const Row* super, const Table* table) {

Process.h

@@ -335,6 +335,8 @@ void Process_makeCommandStr(Process* this, const struct Settings_ *settings);
 
 void Process_writeCommand(const Process* this, int attr, int baseAttr, RichString* str);
 
+char processStateChar(ProcessState state);
+
 void Process_updateCPUFieldWidths(float percentage);
 
 #endif

Settings.h

@@ -110,6 +110,7 @@ typedef struct Settings_ {
    bool topologyAffinity;
    #endif
 
+   char* stateFilter; // store stateFilter argument
    bool changed;
    uint64_t lastUpdate;
 } Settings;