init.c revision 275970
1/** 2 * \file initialize.c 3 * 4 * initialize the libopts data structures. 5 * 6 * @addtogroup autoopts 7 * @{ 8 */ 9/* 10 * This file is part of AutoOpts, a companion to AutoGen. 11 * AutoOpts is free software. 12 * AutoOpts is Copyright (C) 1992-2014 by Bruce Korb - all rights reserved 13 * 14 * AutoOpts is available under any one of two licenses. The license 15 * in use must be one of these two and the choice is under the control 16 * of the user of the license. 17 * 18 * The GNU Lesser General Public License, version 3 or later 19 * See the files "COPYING.lgplv3" and "COPYING.gplv3" 20 * 21 * The Modified Berkeley Software Distribution License 22 * See the file "COPYING.mbsd" 23 * 24 * These files have the following sha256 sums: 25 * 26 * 8584710e9b04216a394078dc156b781d0b47e1729104d666658aecef8ee32e95 COPYING.gplv3 27 * 4379e7444a0e2ce2b12dd6f5a52a27a4d02d39d247901d3285c88cf0d37f477b COPYING.lgplv3 28 * 13aa749a5b0a454917a944ed8fffc530b784f5ead522b1aacaf4ec8aa55a6239 COPYING.mbsd 29 */ 30 31/* = = = START-STATIC-FORWARD = = = */ 32static tSuccess 33do_presets(tOptions * opts); 34/* = = = END-STATIC-FORWARD = = = */ 35 36/** 37 * Make sure the option descriptor is there and that we understand it. 38 * This should be called from any user entry point where one needs to 39 * worry about validity. (Some entry points are free to assume that 40 * the call is not the first to the library and, thus, that this has 41 * already been called.) 42 * 43 * Upon successful completion, pzProgName and pzProgPath are set. 44 * 45 * @param[in,out] opts program options descriptor 46 * @param[in] pname name of program, from argv[] 47 * @returns SUCCESS or FAILURE 48 */ 49LOCAL tSuccess 50validate_struct(tOptions * opts, char const * pname) 51{ 52 if (opts == NULL) { 53 fputs(zno_opt_arg, stderr); 54 return FAILURE; 55 } 56 print_exit = ((opts->fOptSet & OPTPROC_SHELL_OUTPUT) != 0); 57 58 /* 59 * IF the client has enabled translation and the translation procedure 60 * is available, then go do it. 61 */ 62 if ( ((opts->fOptSet & OPTPROC_TRANSLATE) != 0) 63 && (opts->pTransProc != NULL) 64 && (option_xlateable_txt.field_ct != 0) ) { 65 /* 66 * If option names are not to be translated at all, then do not do 67 * it for configuration parsing either. (That is the bit that really 68 * gets tested anyway.) 69 */ 70 if ((opts->fOptSet & OPTPROC_NO_XLAT_MASK) == OPTPROC_NXLAT_OPT) 71 opts->fOptSet |= OPTPROC_NXLAT_OPT_CFG; 72 (*opts->pTransProc)(); 73 } 74 75 /* 76 * IF the struct version is not the current, and also 77 * either too large (?!) or too small, 78 * THEN emit error message and fail-exit 79 */ 80 if ( ( opts->structVersion != OPTIONS_STRUCT_VERSION ) 81 && ( (opts->structVersion > OPTIONS_STRUCT_VERSION ) 82 || (opts->structVersion < OPTIONS_MINIMUM_VERSION ) 83 ) ) { 84 85 static char const ao_ver_string[] = 86 STR(AO_CURRENT)":"STR(AO_REVISION)":"STR(AO_AGE)"\n"; 87 88 fprintf(stderr, zwrong_ver, pname, NUM_TO_VER(opts->structVersion)); 89 if (opts->structVersion > OPTIONS_STRUCT_VERSION ) 90 fputs(ztoo_new, stderr); 91 else 92 fputs(ztoo_old, stderr); 93 94 fwrite(ao_ver_string, sizeof(ao_ver_string) - 1, 1, stderr); 95 return FAILURE; 96 } 97 98 /* 99 * If the program name hasn't been set, then set the name and the path 100 * and the set of equivalent characters. 101 */ 102 if (opts->pzProgName == NULL) { 103 char const * pz = strrchr(pname, DIRCH); 104 char const ** pp = 105 (char const **)(void **)&(opts->pzProgName); 106 107 if (pz != NULL) 108 *pp = pz+1; 109 else 110 *pp = pname; 111 112 pz = pathfind(getenv("PATH"), (char *)pname, "rx"); 113 if (pz != NULL) 114 pname = (void *)pz; 115 116 pp = (char const **)(void **)&(opts->pzProgPath); 117 *pp = pname; 118 119 /* 120 * when comparing long names, these are equivalent 121 */ 122 strequate(zSepChars); 123 } 124 125 return SUCCESS; 126} 127 128/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 129 * 130 * DO PRESETS 131 * 132 * The next several routines do the immediate action pass on the command 133 * line options, then the environment variables, then the config files in 134 * reverse order. Once done with that, the order is reversed and all 135 * the config files and environment variables are processed again, this 136 * time only processing the non-immediate action options. do_presets() 137 * will then return for optionProcess() to do the final pass on the command 138 * line arguments. 139 */ 140 141/** 142 * scan the command line for immediate action options. 143 * This is only called the first time through. 144 * While this procedure is active, the OPTPROC_IMMEDIATE is true. 145 * 146 * @param pOpts program options descriptor 147 * @returns SUCCESS or FAILURE 148 */ 149LOCAL tSuccess 150immediate_opts(tOptions * opts) 151{ 152 tSuccess res; 153 154 opts->fOptSet |= OPTPROC_IMMEDIATE; 155 opts->curOptIdx = 1; /* start by skipping program name */ 156 opts->pzCurOpt = NULL; 157 158 /* 159 * Examine all the options from the start. We process any options that 160 * are marked for immediate processing. 161 */ 162 for (;;) { 163 tOptState opt_st = OPTSTATE_INITIALIZER(PRESET); 164 165 res = next_opt(opts, &opt_st); 166 switch (res) { 167 case FAILURE: goto failed_option; 168 case PROBLEM: res = SUCCESS; goto leave; 169 case SUCCESS: break; 170 } 171 172 /* 173 * IF this is an immediate-attribute option, then do it. 174 */ 175 if (! DO_IMMEDIATELY(opt_st.flags)) 176 continue; 177 178 if (! SUCCESSFUL(handle_opt(opts, &opt_st))) 179 break; 180 } failed_option:; 181 182 if ((opts->fOptSet & OPTPROC_ERRSTOP) != 0) 183 (*opts->pUsageProc)(opts, EXIT_FAILURE); 184 185 leave: 186 187 opts->fOptSet &= ~OPTPROC_IMMEDIATE; 188 return res; 189} 190 191/** 192 * check for preset values from a config files or envrionment variables 193 * 194 * @param[in,out] opts the structure with the option names to check 195 */ 196static tSuccess 197do_presets(tOptions * opts) 198{ 199 tOptDesc * od = NULL; 200 201 if (! SUCCESSFUL(immediate_opts(opts))) 202 return FAILURE; 203 204 /* 205 * IF this option set has a --save-opts option, then it also 206 * has a --load-opts option. See if a command line option has disabled 207 * option presetting. 208 */ 209 if ( (opts->specOptIdx.save_opts != NO_EQUIVALENT) 210 && (opts->specOptIdx.save_opts != 0)) { 211 od = opts->pOptDesc + opts->specOptIdx.save_opts + 1; 212 if (DISABLED_OPT(od)) 213 return SUCCESS; 214 } 215 216 /* 217 * Until we return from this procedure, disable non-presettable opts 218 */ 219 opts->fOptSet |= OPTPROC_PRESETTING; 220 /* 221 * IF there are no config files, 222 * THEN do any environment presets and leave. 223 */ 224 if (opts->papzHomeList == NULL) { 225 env_presets(opts, ENV_ALL); 226 } 227 else { 228 env_presets(opts, ENV_IMM); 229 230 /* 231 * Check to see if environment variables have disabled presetting. 232 */ 233 if ((od != NULL) && ! DISABLED_OPT(od)) 234 intern_file_load(opts); 235 236 /* 237 * ${PROGRAM_LOAD_OPTS} value of "no" cannot disable other environment 238 * variable options. Only the loading of .rc files. 239 */ 240 env_presets(opts, ENV_NON_IMM); 241 } 242 opts->fOptSet &= ~OPTPROC_PRESETTING; 243 244 return SUCCESS; 245} 246 247/** 248 * AutoOpts initialization 249 * 250 * @param[in,out] opts the structure to initialize 251 * @param[in] a_ct program argument count 252 * @param[in] a_v program argument vector 253 */ 254LOCAL bool 255ao_initialize(tOptions * opts, int a_ct, char ** a_v) 256{ 257 if ((opts->fOptSet & OPTPROC_INITDONE) != 0) 258 return true; 259 260 opts->origArgCt = (unsigned int)a_ct; 261 opts->origArgVect = a_v; 262 opts->fOptSet |= OPTPROC_INITDONE; 263 264 if (HAS_pzPkgDataDir(opts)) 265 program_pkgdatadir = opts->pzPkgDataDir; 266 267 if (! SUCCESSFUL(do_presets(opts))) 268 return false; 269 270 /* 271 * IF option name conversion was suppressed but it is not suppressed 272 * for the command line, then it's time to translate option names. 273 * Usage text will not get retranslated. 274 */ 275 if ( ((opts->fOptSet & OPTPROC_TRANSLATE) != 0) 276 && (opts->pTransProc != NULL) 277 && ((opts->fOptSet & OPTPROC_NO_XLAT_MASK) == OPTPROC_NXLAT_OPT_CFG) 278 ) { 279 opts->fOptSet &= ~OPTPROC_NXLAT_OPT_CFG; 280 (*opts->pTransProc)(); 281 } 282 283 if ((opts->fOptSet & OPTPROC_REORDER) != 0) 284 optionSort(opts); 285 286 opts->curOptIdx = 1; 287 opts->pzCurOpt = NULL; 288 return true; 289} 290 291/** @} 292 * 293 * Local Variables: 294 * mode: C 295 * c-file-style: "stroustrup" 296 * indent-tabs-mode: nil 297 * End: 298 * end of autoopts/initialize.c */ 299