displayutil_argutils.m

/*
    displayutil - displayutil_argutils.m

    command line argument handling utility functions

    History:

    v. 1.0.0 (04/06/2021) - Initial version
    v. 1.0.1 (04/15/2021) - Restrict args to exact matches
    v. 1.0.2 (09/05/2021) - add help mode
    v. 1.0.3 (09/07/2021) - add verbose mode
    v. 1.0.4 (09/17/2021) - change verbose, extended, and hidden modes
                            to -l (long), -a (all), and -p (private),
                            respectively
    v. 1.0.5 (04/27/2022) - add plain help without a dash as a valid
                            help mode
    v. 1.0.6 (04/30/2022) - add checking for yes as a mode / argument

    Copyright (c) 2021-2022 Sriranga R. Veeraraghavan <ranga@calalum.org>

    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files (the 
    "Software"), to deal in the Software without restriction, including 
    without limitation the rights to use, copy, modify, merge, publish, 
    distribute, sublicense, and/or sell copies of the Software, and to 
    permit persons to whom the Software is furnished to do so, subject to 
    the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#import <strings.h>
#import <ApplicationServices/ApplicationServices.h>

#import "displayutil_argutils.h"

/* program name */

const char *gPgmName = "displayutil";

/* option strings */

const char *gStrEnable  = "enable";
const char *gStrOn      = "on";
const char *gStrDisable = "disable";
const char *gStrOff     = "off";
const char *gStrAll     = "all";
const char *gStrModeYesLong = "yes";
const char *gStrModeYesShort = "y";
const char *gStrModeAll       = "-a";
const char *gStrModeAllLong   = "-al";
const char *gStrModeHelpShort = "-h";
const char *gStrModeHelpLong  = "-help";
const char *gStrModeHelpPlain = "help";
const char *gStrModeLong      = "-l";
const char *gStrModeLongAll   = "-la";
const char *gStrModePrivate   = "-p";

/* isArg - check if the arg is the requested mode */

bool isArg(const char *arg,
           const char *longMode,
           const char *shortMode)
{
    size_t modeStrLen = 0;

    if (arg == NULL || arg[0] == '\0')
    {
        return false;
    }

    if (longMode != NULL)
    {
        modeStrLen = strlen(longMode);
        if (modeStrLen > 1 && 
            strncasecmp(arg, longMode, modeStrLen) == 0)
        {
            if (strlen(arg) == modeStrLen)
            {
                return true;
            }
            return false;
        }
    }

    if (shortMode == NULL)
    {
        return false;
    }
    
    modeStrLen = strlen(shortMode);
    if (modeStrLen < 1)
    {
        return false;
    }

    if (strncasecmp(arg, shortMode, modeStrLen) == 0 &&
        strlen(arg) == modeStrLen)
    {
        return true;
    }

    return false;
}

/* isArgEnable - check if the arg is enable mode */

bool isArgEnable(const char *arg)
{
    return isArg(arg, gStrEnable, gStrOn);
}

/* isArgDisable - check if the arg is disable mode */

bool isArgDisable(const char *arg)
{
    return isArg(arg, gStrDisable, gStrOff);
}

/* isArgAll - check if the arg is all output mode */

bool isArgAll(const char *arg)
{
    return isArg(arg, gStrModeAll, NULL);
}

/* isArgAllLong - check if the arg is all and long output mode */

bool isArgAllLong(const char *arg)
{
    return isArg(arg, gStrModeAllLong, gStrModeLongAll);
}

/* isArgYes - check if the arg is yes */

bool isArgYes(const char *arg)
{
    return isArg(arg, gStrModeYesLong, gStrModeYesShort);
}

/* isArgHelp - check if the arg is help mode */

bool isArgHelp(const char *arg)
{
    if (isArg(arg, gStrModeHelpLong, gStrModeHelpShort))
    {
        return true;
    }

    return isArg(arg, gStrModeHelpPlain, NULL);
}

/* isArgLong - check if the arg is long output mode */

bool isArgLong(const char *arg)
{
    return isArg(arg, gStrModeLong, NULL);
}

/* isArgPrivate - check if the arg is private information output mode */

bool isArgPrivate(const char *arg)
{
    return isArg(arg, gStrModePrivate, NULL);
}