/*

 *

 * 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 (including the next

 * paragraph) 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.

 */

/*

 * fbc_getargs - Program command line processing

 */

#include <stdio.h>		/* fprintf(), fputs() */

#include <stdlib.h>		/* exit(), malloc(), strtof(), strtol() */

#include <string.h>		/* strchr(), strcmp(), strlen() */

#include "fbc.h"		/* Common fbconf_xorg(1M) definitions */

#include "fbc_error.h"		/* Error reporting */

#include "fbc_getargs.h"	/* Program command line processing */

#include "fbc_keywds.h"		/* Command line keyword look-up */

#include "fbc_properties.h"	/* fbconf_xorg(1M) program properties */

#include "fbc_res.h"		/* Video modes/resolutions (-res option) */

#include "fbc_xorg.h"		/* Edit config file data representations */

/*

 * fbc_search_optvals()

 *

 *    Look up the keyword that has been provided as the value for a

 *    command line option.

 */

void

fbc_search_optvals(

	fbc_varient_t	*fbvar,		/* Program varient data */

	const char	* const	option_name, /* Command line option name */

	const keywd_int_t *keywd_table,	/* Table of recognized keywords */

	const char	* const	option_value, /* Keyword string to look up */

	const keywd_int_t **match_ent_ptr) /* Returned ptr to matching ent */

{

	int		error_code;	/* Error code */

	int		i;		/* Loop counter / array index */

	/*

	 * Look up the option value keyword

	 */

	error_code = fbc_search_keywds((void *)keywd_table,

					sizeof (keywd_int_t),

					option_value,

					(const void **)match_ent_ptr);

	if (error_code != FBC_SUCCESS) {

		if (error_code == FBC_ERR_KWD_INVALID) {

			/*

			 * Handle an unknown/invalid option value keyword

			 */

			fbc_errormsg("Invalid value for -%s option: %s\n",

					option_name, option_value);

			fprintf(stderr, "Valid values for -%s option are:\n",

					option_name);

			for (i = 0; keywd_table[i].argv_name != NULL; i += 1) {

				fprintf(stderr, "\t%s\n",

					keywd_table[i].argv_name);

			}

		} else {

			/*

			 * Handle an ambiguous abbreviation of a value keyword

			 */

			fbc_errormsg("Ambiguous value for -%s option.\n",

					option_name);

			fprintf(stderr, "Possible values are:\n");

			fbc_print_matching_keywds((void *)keywd_table,

						sizeof (keywd_int_t),

						option_value);

		}

		fbvar->usage(stderr, fbvar);

		exit(FBC_EXIT_USAGE);

	}

}	/* fbc_search_optvals() */

/*

 * fbc_add_Option_mod()

 *

 *    Add a config Option entry description to the .Option_mods[] array.

 *

 *    Reject conflicting Option values and consolidate duplicate

 *    descriptions.  (Among other things, duplicates raise the

 *    possibility overfilling the .Option_mods[] array).

 *

 *    Currently supported are Option entries having no value or a single

 *    value.

 *

 *    Use fbvar->modify_config to show that the specified section of

 *    the configuration file is to be modified.

 */

int

fbc_add_Option_mod(

	sectn_mask_t	option_section,	/* Option entry (sub)section */

	const char	*option_name,	/* Option entry name  string */

	const char	*option_value,	/* Option entry value string */

	int (* strcmp_fn)(const char *s1, const char *s2),

					/* strcmp(), strcasecmp(), etc. */

	fbc_varient_t	*fbvar,		/* Program varient data */

	xf86_opt_mod_t	**option_mod_p)	/* Option descr ptr ptr, else NULL */

{

	int		i;		/* Loop counter / array subscript */

	xf86_opt_mod_t	*option_mod;	/* Ptr to Option modification descr */

	/*

	 * A NULL Option description pointer can be returned in case of error

	 */

	if (option_mod_p == NULL) {

		/*

		 * If the caller doesn't want this result, discard it someplace

		 */

		option_mod_p = &option_mod;

	}

	*option_mod_p = NULL;

	/*

	 * Taking this code path shows intent to modify a config file section

	 */

	fbvar->modify_config |= option_section;

	/*

	 * See if this Option was specified already and if the values conflict

	 */

	for (i = 0; i < fbvar->xf86_entry_mods.Option_mods_num; i += 1) {

		/*

		 * Compare the config sections and Option names

		 *

		 *    Differences in alphabetic case aren't expected,

		 *    but are possible if our tables are constructed

		 *    carelessly.  XFree86-style insensitivity to

		 *    whitespace and underscores could be supported,

		 *    should that become an issue.

		 */

		option_mod = &fbvar->xf86_entry_mods.Option_mods[i];

		if ((option_section == option_mod->section) &&

		    (strcasecmp(option_name, option_mod->name) == 0)) {

			/*

			 * Compare the Option values or absence thereof

			 *

			 *    Our caller has provided strcmp_fn that

			 *    does case-insensitive comparisons for

			 *    keywords, or that does case sensitive

			 *    comparisons for other values such as

			 *    pathnames.  Whitespace- and underscore-

			 *    sensitivity could also be controlled in

			 *    this way.

			 */

			if ((option_value      != NULL) ||

			    (option_mod->value != NULL)) {

				if ((option_value      == NULL) ||

				    (option_mod->value == NULL)) {

					/* NULL and non-NULL conflict */

					return (FBC_ERR_OPT_CONFLICT);

				}

				if (strcmp_fn(option_value, option_mod->value)

						!= 0) {

					/* Value strings don't match */

					return (FBC_ERR_OPT_CONFLICT);

				}

			}

			/*

			 * Option name and value have been specified already

			 */

			*option_mod_p = option_mod;

			return (FBC_SUCCESS);

		}

	}

	/*

	 * Point to the next available Option entry description slot

	 *

	 *    Leave space for the array terminator element.

	 */

	option_mod = &fbvar->xf86_entry_mods.Option_mods[

				fbvar->xf86_entry_mods.Option_mods_num];

	fbvar->xf86_entry_mods.Option_mods_num += 1;

	if (fbvar->xf86_entry_mods.Option_mods_num >=

				fbvar->xf86_entry_mods.Option_mods_size) {

		fbc_errormsg("Internal error; array bound exceeded\n");

		exit(FBC_EXIT_FAILURE);

	}

	/*

	 * Fill in the Option entry description

	 */

	option_mod->name    = option_name;

	option_mod->value   = option_value;

	option_mod->section = option_section;

	*option_mod_p = option_mod;

	return (FBC_SUCCESS);

}	/* fbc_add_Option_mod() */

/*

 * fbc_add_radio_Option_mod()

 *

 *    Add a config Option entry description to the .Option_mods[] array.

 *    If this and other Options are ganged together in radio button

 *    fashion (e.g., if one's value is set to True then all others' must

 *    be False) then reset the values of the other Options when

 *    necesary.  Note that these Options are all assumed to belong to

 *    the same, single section of the configuration file.

 *

 *    If the Option value is a keyword, look up the command line

 *    argument and convert it to its config file form.

 *

 *    For all Option descriptions that are to be added, reject

 *    conflicting Option values and consolidate duplicate descriptions.

 */

void

fbc_add_radio_Option_mod(

	const keywd_int_t *keywd_table,	/* Table of recognized keywords */

	const char	*option_reset_value, /* Opt reset keyword, else NULL */

	char	* const	argv[],		/* Program argument vector */

	int		arg,		/* Program argument subscript */

	fbc_varient_t	*fbvar,		/* Program varient data */

	const void	*fbopt_descr,	/* Ptr to cmd line option descr */

	xf86_opt_mod_t	**option_mod_p)	/* Option descr ptr ptr, else NULL */

{

	const keywd_int_t *match_ent_ptr; /* Ptr to matching keyword entry */

	const char	*option_name;	/* Option name  string */

	const char	*option_value;	/* Option value string */

	int (* strcmp_fn)(const char *s1, const char *s2);

					/* strcmp(), strcasecmp(), etc. */

	/*

	 * See whether the config Option value involves a keyword look-up

	 */

	option_value = argv[arg+1];

	strcmp_fn = &strcmp;		/* Assume case-sensitive value */

	if (keywd_table != NULL) {

		/*

		 * Validate the config Option's keyword value

		 */

		fbc_search_optvals(fbvar,

				((fbopt_descr_t *)fbopt_descr)->argv_name,

				keywd_table,

				option_value,

				&match_ent_ptr);

		/*

		 * Get the Option value as it will appear in the config file

		 *

		 *    If the .conf_name hasn't been provided (e.g.,

		 *    fbc_keywds_Samples[]), use the .argv_name.

		 */

		option_value = match_ent_ptr->conf_name;

		if (option_value == NULL) {

			option_value = match_ent_ptr->argv_name;

		}

		strcmp_fn = &strcasecmp; /* Keywords are case insensitive */

	}

	/*

	 * Set up the Option description for the config file

	 */

	option_name = ((const fbopt_descr_t *)fbopt_descr)->conf_name;

	if (fbc_add_Option_mod(

			((const fbopt_descr_t *)fbopt_descr)->section,

			option_name,

			option_value,

			strcmp_fn,

			fbvar,

			option_mod_p) != FBC_SUCCESS) {

		fbc_errormsg("Conflicting option, %s %s\n",

				argv[arg], argv[arg+1]);

		exit(FBC_EXIT_USAGE);

	}

	/*

	 * See whether setting this value should reset related Option values

	 *

	 *    The values of related Options should be reset (in radio

	 *    button fashion) if:

	 *      * A reset value (option_reset_value) has been provided

	 *      * The value of this Option isn't the reset value

	 *      * Related Options exist

	 */

	if ((option_reset_value != NULL) &&

	    (strcasecmp(option_value, option_reset_value) != 0)) {

		/*

		 * Reset each related Option value

		 */

		for (;;) {

			option_name += strlen(option_name) + 1;

			if (*option_name == '\0') {

				break;

			}

			/*

			 * Set up the Option description for the config file

			 */

			if (fbc_add_Option_mod(

					((const fbopt_descr_t *)fbopt_descr)->

								section,

					option_name,

					option_reset_value,

					strcmp_fn,

					fbvar,

					NULL) != FBC_SUCCESS) {

				fbc_errormsg(

				"Conflicting associated option, %s %s\n",

						argv[arg], argv[arg+1]);

				exit(FBC_EXIT_USAGE);

			}

		}

	}

}	/* fbc_add_radio_Option_mod() */

#ifdef FBC_FUTURE

/*

 * fbc_Option_none()

 *

 *    Handle a configuration Option entry having no Option value.

 *

 *    Note: This is a fbc_getopt_fn_t typed function.

 */

void

fbc_Option_none(

	char	* const	argv[],		/* Program argument vector */

	int		*arg,		/* Program argument subscript */

	fbc_varient_t	*fbvar,		/* Program varient data */

	const void	*fbopt_descr)	/* Ptr to cmd line option descr */

{

	if (fbc_add_Option_mod(((const fbopt_descr_t *)fbopt_descr)->section,

			((const fbopt_descr_t *)fbopt_descr)->conf_name,

			NULL,		/* Option entry has no value */

			&strcmp,	/* Not used; there's no value */

			fbvar,

			NULL) != FBC_SUCCESS) {

		fbc_errormsg("Conflicting option, %s\n", argv[*arg]);

		exit(FBC_EXIT_USAGE);

	}

}	/* fbc_Option_none() */

#endif	/* FBC_FUTURE */

/*

 * Keyword tables for command line options having keyword arguments

 *

 *    The zeroth keywd_int_t array element contains the "radio button"

 *    reset value in its .conf_name member.  The zeroth element is not

 *    part of the keyword look-up table.  The keyword look-up table

 *    begins at array element [1].

 */

	/* True | False */

const keywd_int_t fbc_keywds_boolean[] = {

	{ NULL,      "False", FBC_Bool_False },	/* Reset value (Boolean) */

	{ "true",    "True",  FBC_Bool_True  },	/* Start of keyword table */

	{ "false",   "False", FBC_Bool_False },

	{ "enable",  "True",  FBC_Bool_True  },

	{ "disable", "False", FBC_Bool_False },

	{ "yes",     "Yes",   FBC_Bool_True  },

	{ "no",      "No",    FBC_Bool_False },

	{ "on",      "On",    FBC_Bool_True  },

	{ "off",     "Off",   FBC_Bool_False },

	{ "0",       "0",     FBC_Bool_False },

	{ "1",       "1",     FBC_Bool_True  },

	{ NULL,      NULL,    FBC_Bool_False }	/* End of keyword table */

};

	/* Enable | Disable */

const keywd_int_t fbc_keywds_xable[] = {

	{ NULL,      "Disable", FBC_Bool_False }, /* Reset value (Boolean) */

	{ "enable",  "Enable",  FBC_Bool_True  }, /* Start of keyword table */

	{ "disable", "Disable", FBC_Bool_False },

	{ "true",    "Enable",  FBC_Bool_True  },

	{ "false",   "Disable", FBC_Bool_False },

	{ "on",      "Enable",  FBC_Bool_True  },

	{ "off",     "Disable", FBC_Bool_False },

	{ "yes",     "Enable",  FBC_Bool_True  },

	{ "no",      "Disable", FBC_Bool_False },

	{ NULL,      NULL,      FBC_Bool_False }  /* End of keyword table */

};

	/* -outputs Swapped | Direct */

const keywd_int_t fbc_keywds_swappedirect[] = {

	{ NULL,      "Direct",  FBC_Bool_False }, /* Reset value (Boolean) */

	{ "swapped", "Swapped", FBC_Bool_True  }, /* Start of keyword table */

	{ "direct",  "Direct",  FBC_Bool_False },

	{ "true",    "Swapped", FBC_Bool_True  },

	{ "false",   "Direct",  FBC_Bool_False },

	{ "yes",     "Swapped", FBC_Bool_True  },

	{ "no",      "Direct",  FBC_Bool_False },

	{ NULL,      NULL,      FBC_Bool_False }  /* End of keyword table */

};

	/* -slave Disable | Multiview | ... */

const keywd_int_t fbc_keywds_MultiviewMode[] = {

	{ NULL,        NULL,        0                       }, /* No reset */

	{ "disable",   "Disable",   FBC_Multiview_Disable   }, /* Start */

	{ "multiview", "Multiview", FBC_Multiview_Multiview },

#ifdef U22only

	{ "bnc",       "BNC",       FBC_Multiview_BNC       },

#endif

	{ NULL,        NULL,        0                       }  /* End */

};

	/* -multisample Disable | Available | ForceOn */

const keywd_int_t fbc_keywds_Multisample[] = {

	{ NULL,        NULL,        0                   }, /* No reset value */

	{ "disable",   "Disable",   FBC_SampleMode_Off  }, /* Start of table */

	{ "available", "Available", FBC_SampleMode_On   },

	{ "forceon",   "ForceOn",   FBC_SampleMode_Auto },

	{ "off",       "Disable",   FBC_SampleMode_Off  },

	{ "on",        "Available", FBC_SampleMode_On   },

	{ "enable",    "Available", FBC_SampleMode_On   },

	{ "auto",      "ForceOn",   FBC_SampleMode_Auto },

	{ "true",      "Available", FBC_SampleMode_On   },

	{ "false",     "Disable",   FBC_SampleMode_Off  },

	{ NULL,        NULL,        0                   }  /* End of table */

};

	/* -samples */

const keywd_int_t fbc_keywds_Samples[] = {

	{ NULL,  NULL,  0 },		/* No reset value defined */

	{ "1",   NULL,  1 },		/* Start of keyword table */

	{ "4",   NULL,  4 },

	{ "8",   NULL,  8 },

	{ "16",  NULL, 16 },

	{ NULL,  NULL,  0 }		/* End of keyword table */

};

/*

 * fbc_Option_keyword()

 *

 *    Handle an configuration Option entry having a keyword value (that

 *    is independent of other Option entries),

 *

 *        Option  "Clone"         "Enable"|"Disable"      # -clone

 *

 *        Option  "MultiviewMode" "Disable"|"Multiview"   # -slave

 *

 *        Option  "Multisample"   "Disable"|"Available"|"ForceOn"

 *

 *        Option  "Samples"       "1"|"4"|"8"|"16"        # -samples

 *

 *        Option  "StereoEnable"  "Enable"|"Disable"      # -stereo

 *

 *    or multiple such configuration Option entries that are ganged

 *    together in radio-button fashion.

 *

 *        Option  "DefLinear"      "True"|"False"         # -deflinear

 *        Option  "DefOverlay"     "True"|"False"         # -defoverlay

 *        Option  "DefTransparent" "True"|"False"         # -deftransparent

 *

 *        Option  "DoubleWide"    "Enable"|"Disable"      # -doublewide

 *        Option  "DoubleHigh"    "Enable"|"Disable"      # -doublehigh

 *

 *    If this and other Options are ganged together in radio button

 *    fashion (e.g., if one's value is set to True then all others' must

 *    be False) then reset the values of the other Options when

 *    necessary.

 *

 *    Note: This is a fbc_getopt_fn_t typed function.

 */

void

fbc_Option_keyword(

	char	* const	argv[],		/* Program argument vector */

	int		*arg,		/* Program argument subscript */

	fbc_varient_t	*fbvar,		/* Program varient data */

	const void	*fbopt_descr)	/* Ptr to cmd line option descr */

{

	const keywd_int_t *keywd_table;	/* Table of recognized keywords */

	/*

	 * Prepare an Option entry having a Boolean-style keyword value

	 */

	keywd_table = ((fbopt_descr_t *)fbopt_descr)->keywd_table;

	fbc_add_radio_Option_mod(&keywd_table[1],

				keywd_table[0].conf_name,

				argv,

				*arg,

				fbvar,

				fbopt_descr,

				NULL);

}	/* fbc_Option_keyword() */

#ifndef FBC_FUTURE

/*

 * fbc_Option_int()

 *

 *    Handle a configuration Option entry having an integer value.

 *

 *    Note: This is a fbc_getopt_fn_t typed function.

 */

void

fbc_Option_int(

	char	* const	argv[],		/* Program argument vector */

	int		*arg,		/* Program argument subscript */