util.c

#include "util.h"
#include "graphics.h"     // for ANSI_FG_RED, ANSI_RESET_ALL
#include "main.h"         // for options_t, window_t
#include "timer.h"        // for timespecsub
#include <getopt.h>       // for no_argument, getopt_long, option, requ...
#include <stdarg.h>       // for va_end, va_start
#include <stdbool.h>      // for false, true, bool
#include <stdio.h>        // for puts, NULL, printf, fopen, fputs, vprintf
#include <stdlib.h>       // for exit, EXIT_FAILURE, EXIT_SUCCESS
#include <stdnoreturn.h>  // for noreturn
#include <time.h>         // for timespec, clock_gettime, CLOCK_MONOTONIC


unsigned printable_strlen(const char* str)
{
    unsigned length = 0;
    bool skip = false;

    while (*str != '\0')
    {
        if (*str == '\e')
            skip = true;

        if (skip)
        {
            if (*str == 'm')
                skip = false;
        }
        else if ((*str >= ' ') && (*str <= '~'))
            length++;

        str++;
    }
    return length;
}


double proc_runtime(window_t* window)
{
    struct timespec timeDiff;
    struct timespec now;

    clock_gettime(CLOCK_MONOTONIC, &now);
    timespecsub(&now, &window->procStartTime, &timeDiff);

    return timeDiff.tv_sec + (timeDiff.tv_nsec * 1e-9);
}



const char** getArgs(int argc, char** argv, FILE** outputFile, options_t* options)
{
    static struct option longOpts[] = {{"append", no_argument, NULL, 'a'},
                                       {"debug", no_argument, NULL, 'd'},
                                       {"explicit", no_argument, NULL, 'e'},
                                       {"help", no_argument, NULL, 'h'},
                                       {"output-file", required_argument, NULL, 'o'},
                                       {"verbose", no_argument, NULL, 'v'},
                                       {"version", no_argument, NULL, 'V'},
                                       {NULL, no_argument, NULL, 0}};
    int optc;
    bool append = false;
    char* outFilename = NULL;
    options->verbose = false;
    options->debug = false;
    options->useScrollingRegion = true;

    while ((optc = getopt_long(argc, argv, "+aedho:vV", longOpts, (int*)0)) != EOF)
    {
        switch (optc)
        {
        case 'h':
            showUsage(EXIT_SUCCESS);  // Doesn't return
        case 'v':
            options->verbose = true;
            break;
        case 'V':
            showVersion(EXIT_SUCCESS);  // Doesn't return
        case 'a':
            append = true;
            break;
        case 'o':
            outFilename = optarg;
            break;
        case 'd':
            options->debug = true;
            break;
        case 'e':
            options->useScrollingRegion = false;
            break;
        default:
            showUsage(EXIT_FAILURE);
        }
    }

    if (optind == argc)
    {
        showError(EXIT_FAILURE, true, "Can't find a program to run, optind = %d\n\n",
                  optind);
    }

    if (outFilename)
    {
        *outputFile = fopen(outFilename, (append) ? "a" : "w");

        if (*outputFile == NULL)
            showError(EXIT_FAILURE, false, "Couldn't open file: %s\n", outFilename);
    }

    return (const char**)&argv[optind];
}


noreturn void showUsage(int status)
{
    puts("Monitor COMMAND output and system usage in a single terminal\n");

    printf("Usage: %s [OPTION]... COMMAND [ARG]...\n", PROGRAM_NAME);
    puts("\t-a, --append       When using -o FILE, append instead of overwriting");
    puts("\t-d, --debug        Create a very verbose debug file of stdout and stdin");
    puts("\t-e, --explicit     Some terminal emulators don't work nicely when using");
    puts("\t                   scrolling-regions, performing scrolling explicitly with");
    puts("\t                   CSI commands should have better compatability");
    puts("\t-h, --help         Display this help and exit");
    puts("\t-o, --output=FILE  Write output to FILE as well as stdout");
    puts("\t-v, --verbose      Display all output from the child process");
    puts("\t-V, --version      Output version information and exit");

    puts("\nExamples:");
    puts("\tprocproc make      Build a project, showing progress and system usage");
    puts("\tprocprog -v 7z b   Run a benchmark to test the usage display and show all "
         "output");

    printf("\nReport bugs to <%s>\n", CONTACTS);

    exit(status);
}



noreturn void showVersion(int status)
{
    printf("%s %s\n\n", PROGRAM_NAME, VERSION);
    printf("Copyright (C) %s %s\n", BUILD_YEAR, AUTHORS);
    printf("All rights reserved.\n");
    printf("License BSD 2-Clause \"Simplified\" License: "
           "<https://spdx.org/licenses/BSD-2-Clause.html>\n\n");
    printf("Written by %s\n", AUTHORS);

    exit(status);
}


noreturn void showError(int status, bool shouldShowUsage, const char* format, ...)
{
    va_list varArgs;

    fputs(ANSI_FG_RED "Error " ANSI_RESET_ALL, stderr);

    va_start(varArgs, format);
    vprintf(format, varArgs);
    va_end(varArgs);

    if (shouldShowUsage)
    {
        showUsage(status);
    }
    else
    {
        exit(status);
    }
}