Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

463 lines
9.5 KiB

/*
* inifile.c - Initialization file processing module.
*/
/* Headers
**********/
#include "project.h"
#pragma hdrstop
#ifdef DEBUG
/* Constants
************/
/* maximum length of .ini switch RHS */
#define MAX_INI_SWITCH_RHS_LEN MAX_PATH_LEN
/* Module Variables
*******************/
#pragma data_seg(DATA_SEG_READ_ONLY)
/* Boolean TRUE strings used by IsIniYes() (comparison is case-insensitive) */
PRIVATE_DATA const PCSTR s_rgcszTrue[] =
{
"1",
"On",
"True",
"Y",
"Yes"
};
/* Boolean FALSE strings used by IsIniYes() (comparison is case-insensitive) */
PRIVATE_DATA const PCSTR s_rgcszFalse[] =
{
"0",
"Off",
"False",
"N",
"No"
};
#pragma data_seg()
#endif
/***************************** Private Functions *****************************/
/* Module Prototypes
********************/
#ifdef DEBUG
PRIVATE_CODE BOOL SetBOOLIniSwitch(PCBOOLINISWITCH);
PRIVATE_CODE BOOL SetDecimalIntIniSwitch(PCDECINTINISWITCH);
PRIVATE_CODE BOOL SetIniSwitch(PCVOID);
PRIVATE_CODE BOOL IsYesString(PCSTR);
PRIVATE_CODE BOOL IsNoString(PCSTR);
PRIVATE_CODE BOOL IsStringInList(PCSTR, const PCSTR *, UINT);
PRIVATE_CODE BOOL IsValidPCBOOLINISWITCH(PCBOOLINISWITCH);
PRIVATE_CODE BOOL IsValidPCDECINTINISWITCH(PCDECINTINISWITCH);
PRIVATE_CODE BOOL IsValidPCUNSDECINTINISWITCH(PCUNSDECINTINISWITCH);
#endif
#ifdef DEBUG
/*
** SetBOOLIniSwitch()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL SetBOOLIniSwitch(PCBOOLINISWITCH pcbis)
{
DWORD dwcbKeyLen;
char rgchRHS[MAX_INI_SWITCH_RHS_LEN];
ASSERT(IS_VALID_STRUCT_PTR(pcbis, CBOOLINISWITCH));
/* Set boolean .ini switch. */
dwcbKeyLen = GetPrivateProfileString(g_pcszIniSection, pcbis->pcszKeyName,
"", rgchRHS, sizeof(rgchRHS),
g_pcszIniFile);
/* Is the .ini switch set? */
if (rgchRHS[0])
{
/* Yes. Set or clear flag? */
if (IsYesString(rgchRHS))
{
/* Set flag. */
if (IS_FLAG_CLEAR(*(pcbis->pdwParentFlags), pcbis->dwFlag))
{
SET_FLAG(*(pcbis->pdwParentFlags), pcbis->dwFlag);
WARNING_OUT(("SetBOOLIniSwitch(): %s set in %s![%s].",
pcbis->pcszKeyName,
g_pcszIniFile,
g_pcszIniSection));
}
}
else if (IsNoString(rgchRHS))
{
/* Clear flag. */
if (IS_FLAG_SET(*(pcbis->pdwParentFlags), pcbis->dwFlag))
{
CLEAR_FLAG(*(pcbis->pdwParentFlags), pcbis->dwFlag);
WARNING_OUT(("SetBOOLIniSwitch(): %s cleared in %s![%s].",
pcbis->pcszKeyName,
g_pcszIniFile,
g_pcszIniSection));
}
}
else
/* Unknown flag. */
WARNING_OUT(("SetBOOLIniSwitch(): Found unknown Boolean RHS %s for %s in %s![%s].",
rgchRHS,
pcbis->pcszKeyName,
g_pcszIniFile,
g_pcszIniSection));
}
return(TRUE);
}
/*
** SetDecimalIntIniSwitch()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL SetDecimalIntIniSwitch(PCDECINTINISWITCH pcdiis)
{
INT nNewValue;
ASSERT(IS_VALID_STRUCT_PTR(pcdiis, CDECINTINISWITCH));
/* Get decimal integer .ini switch. */
nNewValue = GetPrivateProfileInt(g_pcszIniSection, pcdiis->pcszKeyName,
*(pcdiis->pnValue), g_pcszIniFile);
/* New value? */
if (nNewValue != *(pcdiis->pnValue))
{
/* Yes. */
*(pcdiis->pnValue) = nNewValue;
WARNING_OUT(("SetDecimalIntIniSwitch(): %s set to %d in %s![%s].",
pcdiis->pcszKeyName,
*(pcdiis->pnValue),
g_pcszIniFile,
g_pcszIniSection));
}
return(TRUE);
}
/*
** SetUnsignedDecimalIntIniSwitch()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL SetUnsignedDecimalIntIniSwitch(PCUNSDECINTINISWITCH pcudiis)
{
INT nNewValue;
ASSERT(IS_VALID_STRUCT_PTR(pcudiis, CUNSDECINTINISWITCH));
/* Get unsigned decimal integer .ini switch as signed decimal integer. */
ASSERT(*(pcudiis->puValue) <= INT_MAX);
nNewValue = GetPrivateProfileInt(g_pcszIniSection, pcudiis->pcszKeyName,
*(pcudiis->puValue), g_pcszIniFile);
if (nNewValue >= 0)
{
if ((UINT)nNewValue != *(pcudiis->puValue))
{
/* New non-negative value. */
*(pcudiis->puValue) = nNewValue;
WARNING_OUT(("SetUnsignedDecimalIntIniSwitch(): %s set to %u in %s![%s].",
pcudiis->pcszKeyName,
*(pcudiis->puValue),
g_pcszIniFile,
g_pcszIniSection));
}
}
else
/* Negative value. */
WARNING_OUT(("SetUnsignedDecimalIntIniSwitch(): Unsigned value %s set to %d in %s![%s]. Ignored.",
pcudiis->pcszKeyName,
nNewValue,
g_pcszIniFile,
g_pcszIniSection));
return(TRUE);
}
/*
** SetIniSwitch()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL SetIniSwitch(PCVOID pcvIniSwitch)
{
BOOL bResult;
ASSERT(IS_VALID_READ_PTR((PCINISWITCHTYPE)pcvIniSwitch, CINISWITCHTYPE));
/* Set .ini switch based upon type. */
switch (*(PCINISWITCHTYPE)pcvIniSwitch)
{
case IST_BOOL:
bResult = SetBOOLIniSwitch(pcvIniSwitch);
break;
case IST_DEC_INT:
bResult = SetDecimalIntIniSwitch(pcvIniSwitch);
break;
case IST_UNS_DEC_INT:
bResult = SetUnsignedDecimalIntIniSwitch(pcvIniSwitch);
break;
default:
ERROR_OUT(("SetIniSwitch(): Unrecognized .ini switch type %d.",
*(PCINISWITCHTYPE)pcvIniSwitch));
bResult = FALSE;
break;
}
return(bResult);
}
/*
** IsYesString()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL IsYesString(PCSTR pcsz)
{
ASSERT(IS_VALID_STRING_PTR(pcsz, CSTR));
return(IsStringInList(pcsz, s_rgcszTrue, ARRAY_ELEMENTS(s_rgcszTrue)));
}
/*
** IsNoString()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL IsNoString(PCSTR pcsz)
{
ASSERT(IS_VALID_STRING_PTR(pcsz, CSTR));
return(IsStringInList(pcsz, s_rgcszFalse, ARRAY_ELEMENTS(s_rgcszFalse)));
}
/*
** IsStringInList()
**
** Determines whether or not a given string matches a string in a list of
** strings.
**
** Arguments: pcsz - pointer to string to be checked
**
** Returns:
**
** Side Effects: none
**
** N.b., string comparison is case-insensitive.
*/
PRIVATE_CODE BOOL IsStringInList(PCSTR pcsz, const PCSTR *pcpcszList,
UINT ucbStrings)
{
UINT u;
BOOL bFound = FALSE;
ASSERT(IS_VALID_STRING_PTR(pcsz, CSTR));
ASSERT(IS_VALID_READ_BUFFER_PTR(pcpcszList, PCSTR, ucbStrings * sizeof(*pcpcszList)));
/* Search the list for the given string. */
for (u = 0; u < ucbStrings; u++)
{
ASSERT(IS_VALID_STRING_PTR(pcpcszList[u], CSTR));
if (! lstrcmpi(pcsz, pcpcszList[u]))
{
bFound = TRUE;
break;
}
}
return(bFound);
}
/*
** IsValidPCBOOLINIKEY()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL IsValidPCBOOLINISWITCH(PCBOOLINISWITCH pcbis)
{
return(IS_VALID_READ_PTR(pcbis, CBOOLINISWITCH) &&
EVAL(pcbis->istype == IST_BOOL) &&
IS_VALID_STRING_PTR(pcbis->pcszKeyName, CSTR) &&
IS_VALID_WRITE_PTR(pcbis->pdwParentFlags, DWORD) &&
EVAL(pcbis->dwFlag));
}
/*
** IsValidPCDECINTINISWITCH()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL IsValidPCDECINTINISWITCH(PCDECINTINISWITCH pcdiis)
{
return(IS_VALID_READ_PTR(pcdiis, CDECINTINISWITCH) &&
EVAL(pcdiis->istype == IST_DEC_INT) &&
IS_VALID_STRING_PTR(pcdiis->pcszKeyName, CSTR) &&
IS_VALID_WRITE_PTR(pcdiis->pnValue, INT));
}
/*
** IsValidPCUNSDECINTINISWITCH()
**
**
**
** Arguments:
**
** Returns:
**
** Side Effects: none
*/
PRIVATE_CODE BOOL IsValidPCUNSDECINTINISWITCH(PCUNSDECINTINISWITCH pcudiis)
{
return(IS_VALID_READ_PTR(pcudiis, CUNSDECINTINISWITCH) &&
EVAL(pcudiis->istype == IST_UNS_DEC_INT) &&
IS_VALID_STRING_PTR(pcudiis->pcszKeyName, CSTR) &&
IS_VALID_WRITE_PTR(pcudiis->puValue, UINT));
}
#endif
/****************************** Public Functions *****************************/
#ifdef DEBUG
/*
** SetIniSwitches()
**
** Set flags from initialization file.
**
** Arguments: ppcvIniSwitches - pointer to array of pointers to .ini switch
** structures describing .ini switches to set
** ucSwitches - number of .ini switch pointers in
** ppcvIniSwitches array
**
** Returns: TRUE if .ini switch processing is successful. FALSE if not.
**
** Side Effects: none
**
** N.b, the global variables g_pcszIniFile and g_pcszIniSection must be filled in
** before calling SetIniSwitches().
*/
PUBLIC_CODE BOOL SetIniSwitches(const PCVOID *pcpcvIniSwitches, UINT ucSwitches)
{
BOOL bResult = TRUE;
UINT u;
ASSERT(IS_VALID_READ_BUFFER_PTR(pcpcvIniSwitches, const PCVOID, ucSwitches * sizeof(*pcpcvIniSwitches)));
/* Process .ini switches. */
for (u = 0; u < ucSwitches; u++)
bResult = SetIniSwitch(pcpcvIniSwitches[u]) && bResult;
return(bResult);
}
#endif