devmode.c File Reference

#include "precomp.h"

Include dependency graph for devmode.c:

Go to the source code of this file.

Classes
struct	_MINIMUM_SIZE_TABLE

Typedefs
typedef struct _MINIMUM_SIZE_TABLE	MINIMUM_SIZE_TABLE
typedef struct _MINIMUM_SIZE_TABLE *	PMINIMUM_SIZE_TABLE

Functions
static __inline void	_FixStringA (PBYTE String, DWORD cbString)
static __inline void	_FixStringW (PWSTR String, DWORD cbString)
BOOL WINAPI	IsValidDevmodeA (PDEVMODEA pDevmode, size_t DevmodeSize)
BOOL WINAPI	IsValidDevmodeW (PDEVMODEW pDevmode, size_t DevmodeSize)
BOOL WINAPI	IsValidDevmodeNoSizeW (PDEVMODEW pDevmode)
void	RosConvertAnsiDevModeToUnicodeDevmode (PDEVMODEA pDevModeInput, PDEVMODEW *pDevModeOutput)
static __inline DEVMODEA *	_ConvertToDevmodeA (const DEVMODEW *dmW)
void	RosConvertUnicodeDevModeToAnsiDevmode (PDEVMODEW pDevModeInput, PDEVMODEA pDevModeOutput)

Variables
static MINIMUM_SIZE_TABLE	MinimumSizeA []
static MINIMUM_SIZE_TABLE	MinimumSizeW []

Typedef Documentation

MINIMUM_SIZE_TABLE

typedef struct _MINIMUM_SIZE_TABLE MINIMUM_SIZE_TABLE

PMINIMUM_SIZE_TABLE

typedef struct _MINIMUM_SIZE_TABLE * PMINIMUM_SIZE_TABLE

Function Documentation

_ConvertToDevmodeA()

static __inline DEVMODEA * _ConvertToDevmodeA ( const DEVMODEW *  dmW )

static

Definition at line 298 of file devmode.c.

{
    DEVMODEA *dmA;
    WORD dmA_size, dmW_size;
    size_t BytesToCopy;
 
    dmW_size = dmW->dmSize;
 
    /* this is the minimal dmSize that XP accepts */
    if (dmW_size < FIELD_OFFSET(DEVMODEW, dmFields))
        return NULL;
 
    // Guard against callers that set dmSize incorrectly.
    if (dmW_size > sizeof(DEVMODEW))
        dmW_size = sizeof(DEVMODEW);
 
    // dmA_size must become dmW_size without the additional 1 byte per character for each Unicode string (dmDeviceName and dmFormName).
    dmA_size = dmW_size - CCHDEVICENAME;
    if (dmW_size >= FIELD_OFFSET(DEVMODEW, dmFormName) + CCHFORMNAME * sizeof(WCHAR))
        dmA_size -= CCHFORMNAME;
 
    // Allocate the required bytes, that is dmSize for the ANSI DEVMODEA structure plus any extra bytes requested through dmDriverExtra.
    dmA = HeapAlloc(GetProcessHeap(), 0, dmA_size + dmW->dmDriverExtra);
    if (!dmA) return NULL;
 
    // Every valid DEVMODEW has a dmDeviceName, which we convert to ANSI here.
    WideCharToMultiByte(CP_ACP, 0, dmW->dmDeviceName, -1, (LPSTR)dmA->dmDeviceName, CCHDEVICENAME, NULL, NULL);
 
    // Copy everything up to dmFormName or the remaining dmW_size, whatever is smaller.
    BytesToCopy = min(FIELD_OFFSET(DEVMODEW, dmFormName) - FIELD_OFFSET(DEVMODEW, dmSpecVersion), dmW_size - CCHDEVICENAME * sizeof(WCHAR));
    memcpy(&dmA->dmSpecVersion, &dmW->dmSpecVersion, BytesToCopy);
 
    // Handle dmFormName if the input DEVMODEW is large enough to contain one.
    if (dmW_size >= FIELD_OFFSET(DEVMODEW, dmFormName) + CCHFORMNAME * sizeof(WCHAR))
    {
        if (dmW->dmFields & DM_FORMNAME)
            WideCharToMultiByte(CP_ACP, 0, dmW->dmFormName, -1, (LPSTR)dmA->dmFormName, CCHFORMNAME, NULL, NULL);
        else
            dmA->dmFormName[0] = 0;
 
        // Copy the remaining fields.
        if (dmW_size > FIELD_OFFSET(DEVMODEW, dmLogPixels))
            memcpy(&dmA->dmLogPixels, &dmW->dmLogPixels, dmW_size - FIELD_OFFSET(DEVMODEW, dmLogPixels));
    }
 
    // Append dmDriverExtra if required.
    if (dmW->dmDriverExtra)
        memcpy((char *)dmA + dmA_size, (const char *)dmW + dmW_size, dmW->dmDriverExtra);
 
    // Set the corrected dmSize and we are done.
    dmA->dmSize = dmA_size;
 
    return dmA;
}

Referenced by RosConvertUnicodeDevModeToAnsiDevmode().

_FixStringA()

static __inline void _FixStringA ( PBYTE  String, DWORD  cbString  )

static

Replace the last character by a null terminator if the given ANSI string is not null-terminated.

Definition at line 95 of file devmode.c.

{
    const PBYTE pLastCharacter = &String[cbString / sizeof(BYTE) - 1];
    PBYTE p = String;
 
    while (*p)
    {
        if (p == pLastCharacter)
        {
            *p = 0;
            break;
        }
 
        p++;
    }
}

Referenced by IsValidDevmodeA().

_FixStringW()

static __inline void _FixStringW ( PWSTR  String, DWORD  cbString  )

static

Replace the last character by a null terminator if the given Unicode string is not null-terminated.

Definition at line 116 of file devmode.c.

{
    const PWSTR pLastCharacter = &String[cbString / sizeof(WCHAR) - 1];
    PWSTR p = String;
 
    while (*p)
    {
        if (p == pLastCharacter)
        {
            *p = 0;
            break;
        }
 
        p++;
    }
}

Referenced by IsValidDevmodeNoSizeW(), and IsValidDevmodeW().

IsValidDevmodeA()

BOOL WINAPI IsValidDevmodeA	(	PDEVMODEA	pDevmode,
		size_t	DevmodeSize
	)

Definition at line 134 of file devmode.c.

{
    PMINIMUM_SIZE_TABLE pTable = MinimumSizeA;
    WORD wRequiredSize;
 
    TRACE("IsValidDevmodeA(%p, %lu)\n", pDevmode, DevmodeSize);
 
    // Check if a Devmode was given at all.
    if (!pDevmode)
        goto Failure;
 
    // Verify that DevmodeSize is large enough to hold the public and private members of the structure.
    if (DevmodeSize < pDevmode->dmSize + pDevmode->dmDriverExtra)
        goto Failure;
 
    // If the structure has private members, the public structure must be 32-bit packed.
    if (pDevmode->dmDriverExtra && pDevmode->dmSize % 4)
        goto Failure;
 
    // Now determine the minimum possible dmSize based on the given fields in dmFields.
    wRequiredSize = FIELD_OFFSET(DEVMODEA, dmFields) + RTL_FIELD_SIZE(DEVMODEA, dmFields);
 
    while (pTable->dwField)
    {
        if (pDevmode->dmFields & pTable->dwField)
        {
            wRequiredSize = pTable->wSize;
            break;
        }
 
        pTable++;
    }
 
    // Verify that the value in dmSize is big enough for the used fields.
    if (pDevmode->dmSize < wRequiredSize)
        goto Failure;
 
    // Check if dmDeviceName and (if used) dmFormName are null-terminated.
    // Fix this if they aren't.
    _FixStringA(pDevmode->dmDeviceName, sizeof(pDevmode->dmDeviceName));
    if (pDevmode->dmFields & DM_FORMNAME)
        _FixStringA(pDevmode->dmFormName, sizeof(pDevmode->dmFormName));
 
    // Return success without setting the error code.
    return TRUE;
 
Failure:
    SetLastError(ERROR_INVALID_DATA);
    return FALSE;
}

Referenced by START_TEST().

IsValidDevmodeNoSizeW()

BOOL WINAPI IsValidDevmodeNoSizeW

(

PDEVMODEW

pDevmode

)

Definition at line 238 of file devmode.c.

{
    PMINIMUM_SIZE_TABLE pTable = MinimumSizeW;
    WORD wRequiredSize;
 
    TRACE("IsValidDevmodeNoSizeW(%p)\n", pDevmode);
 
    // Check if a Devmode was given at all.
    if (!pDevmode)
        goto Failure;
 
    // If the structure has private members, the public structure must be 32-bit packed.
    if (pDevmode->dmDriverExtra && pDevmode->dmSize % 4)
        goto Failure;
 
    // Now determine the minimum possible dmSize based on the given fields in dmFields.
    wRequiredSize = FIELD_OFFSET(DEVMODEW, dmFields) + RTL_FIELD_SIZE(DEVMODEW, dmFields);
 
    while (pTable->dwField)
    {
        if (pDevmode->dmFields & pTable->dwField)
        {
            wRequiredSize = pTable->wSize;
            break;
        }
 
        pTable++;
    }
 
    // Verify that the value in dmSize is big enough for the used fields.
    if (pDevmode->dmSize < wRequiredSize)
        goto Failure;
 
    // Check if dmDeviceName and (if used) dmFormName are null-terminated.
    // Fix this if they aren't.
    _FixStringW(pDevmode->dmDeviceName, sizeof(pDevmode->dmDeviceName));
    if (pDevmode->dmFields & DM_FORMNAME)
        _FixStringW(pDevmode->dmFormName, sizeof(pDevmode->dmFormName));
 
    // Return success without setting the error code.
    return TRUE;
 
Failure:
    SetLastError(ERROR_INVALID_DATA);
    return FALSE;
}

Referenced by AddPrinterW(), DeviceCapabilitiesW(), DocumentPropertiesW(), QueryColorProfile(), and SetPrinterW().

IsValidDevmodeW()

BOOL WINAPI IsValidDevmodeW	(	PDEVMODEW	pDevmode,
		size_t	DevmodeSize
	)

Definition at line 186 of file devmode.c.

{
    PMINIMUM_SIZE_TABLE pTable = MinimumSizeW;
    WORD wRequiredSize;
 
    TRACE("IsValidDevmodeW(%p, %lu)\n", pDevmode, DevmodeSize);
 
    // Check if a Devmode was given at all.
    if (!pDevmode)
        goto Failure;
 
    // Verify that DevmodeSize is large enough to hold the public and private members of the structure.
    if (DevmodeSize < pDevmode->dmSize + pDevmode->dmDriverExtra)
        goto Failure;
 
    // If the structure has private members, the public structure must be 32-bit packed.
    if (pDevmode->dmDriverExtra && pDevmode->dmSize % 4)
        goto Failure;
 
    // Now determine the minimum possible dmSize based on the given fields in dmFields.
    wRequiredSize = FIELD_OFFSET(DEVMODEW, dmFields) + RTL_FIELD_SIZE(DEVMODEW, dmFields);
 
    while (pTable->dwField)
    {
        if (pDevmode->dmFields & pTable->dwField)
        {
            wRequiredSize = pTable->wSize;
            break;
        }
 
        pTable++;
    }
 
    // Verify that the value in dmSize is big enough for the used fields.
    if (pDevmode->dmSize < wRequiredSize)
        goto Failure;
 
    // Check if dmDeviceName and (if used) dmFormName are null-terminated.
    // Fix this if they aren't.
    _FixStringW(pDevmode->dmDeviceName, sizeof(pDevmode->dmDeviceName));
    if (pDevmode->dmFields & DM_FORMNAME)
        _FixStringW(pDevmode->dmFormName, sizeof(pDevmode->dmFormName));
 
    // Return success without setting the error code.
    return TRUE;
 
Failure:
    SetLastError(ERROR_INVALID_DATA);
    return FALSE;
}

Referenced by START_TEST(), and test_IsValidDevmodeW().

RosConvertAnsiDevModeToUnicodeDevmode()

void RosConvertAnsiDevModeToUnicodeDevmode	(	PDEVMODEA	pDevModeInput,
		PDEVMODEW *	pDevModeOutput
	)

Definition at line 285 of file devmode.c.

{
    // FIXME: This function should become ConvertAnsiDevModeToUnicodeDevmode when its parameters are known!
 
    // Check if a pDevModeInput and pDevModeOutput are both not NULL.
    if (!pDevModeInput || !pDevModeOutput)
        return;
 
    *pDevModeOutput = GdiConvertToDevmodeW(pDevModeInput);
}

Referenced by AddPrinterA(), DeviceCapabilitiesA(), DocumentPropertiesA(), ResetPrinterA(), and SetPrinterA().

RosConvertUnicodeDevModeToAnsiDevmode()

void RosConvertUnicodeDevModeToAnsiDevmode	(	PDEVMODEW	pDevModeInput,
		PDEVMODEA	pDevModeOutput
	)

Definition at line 353 of file devmode.c.

{
    PDEVMODEA pTmp;
 
    // FIXME: This function should become ConvertUnicodeDevModeToAnsiDevmode when its parameters are known!
 
    // Check if a pDevModeInput and pDevModeOutput are both not NULL.
    if (!pDevModeInput || !pDevModeOutput)
        return;
 
    pTmp = _ConvertToDevmodeA(pDevModeInput);
    memcpy( pDevModeOutput, pTmp, pTmp->dmSize + pTmp->dmDriverExtra); // Copy into a Wide char (Larger) buffer.
    HeapFree(hProcessHeap, 0, pTmp);
}

Referenced by DocumentPropertiesA(), EnumJobsA(), EnumPrintersA(), GetJobA(), and GetPrinterA().

Variable Documentation

MinimumSizeA

MINIMUM_SIZE_TABLE MinimumSizeA[]

static

Minimum required DEVMODEA structure size based on the used fields. Must be in descending order!

Definition at line 20 of file devmode.c.

Referenced by IsValidDevmodeA().

MinimumSizeW

MINIMUM_SIZE_TABLE MinimumSizeW[]

static

Minimum required DEVMODEW structure size based on the used fields. Must be in descending order!

Definition at line 57 of file devmode.c.

Referenced by IsValidDevmodeNoSizeW(), and IsValidDevmodeW().