DlgPlate.cpp

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode library.
// Module: Dialog "memory templates" support.
// Author: Copyright (c) Love Nystrom
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#include <uLib/DlgPlate.h>
#include <uLib/StrFunc.h>
//#include <uLib/Debug.h>

// Dialog templates need careful alignment...
PVOID AlignPtr( PVOID Ptr, WORD Chunk ) // Chunk = 2,4,8,16... (power of 2)
{
    --Chunk; return PVOID( DWORD_PTR( PBYTE(Ptr)+Chunk ) & ~DWORD_PTR( Chunk ));
}
PBYTE dwAlign( PBYTE Ptr )
{
    return (PBYTE) (DWORD_PTR(Ptr+3) & ~DWORD_PTR(3)); 
}
PBYTE wAlign( PBYTE Ptr )
{
    return (PBYTE)(DWORD_PTR(Ptr+1) & ~DWORD_PTR(1)); 
}
DWORD_PTR dwPad( DWORD_PTR X )
{
    return (DWORD_PTR(X+3) & ~DWORD_PTR(3)); 
}

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Classic dialog templates
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

static const LPCWSTR S_ShellFont = L"MS Shell Dlg"; // Mandatory for DS_SHELLFONT

LPDLGTEMPLATE AllocDlgTemplate( WORD Size )
{
    // GlobalAlloc allows Windows to unlock and move the template if need be.
    HGLOBAL hMem = GlobalAlloc( GHND, Size );
    return hMem ? (LPDLGTEMPLATE) GlobalLock( hMem ) : NULL;
}
void FreeDlgTemplate( LPDLGTEMPLATE pDlg )
{
    GlobalFree( (HGLOBAL) pDlg );
}

typedef union _ditUniPtr { // Local type
    LPDLGITEMTEMPLATE   pItem;
    PBYTE               pByte;
    PWORD               pWord;
    PDWORD              pDword;
    PWSTR               pwStr;
  } DitUniPtr;

LPDLGITEMTEMPLATE SetDlgStyle( 
    LPDLGTEMPLATE pDlg, 
    DWORD   Style, 
    short X, short Y, 
    short W, short H, 
    LPCWSTR Caption, 
    WORD    nCtls, 
    LPCWSTR Font, 
    WORD    Points
    )
{
    if (DWORD_PTR( pDlg ) & DWORD_PTR( 3 )) { // Check buffer alignment
        SetLastError( ERROR_INVALID_PARAMETER ); // Not DW aligned
        return NULL;
    }
    pDlg->style = Style;
    pDlg->dwExtendedStyle = 0;
    pDlg->cdit = nCtls; 
    pDlg->x = X; // Dialog units..
    pDlg->y = Y;
    pDlg->cx = W;
    pDlg->cy = H;

    DitUniPtr u;
    u.pByte = PBYTE( pDlg+1 );      // Past the header. NOTE: C pointer arithmetic!
    *u.pWord++ = 0x0000;            // No menu
    *u.pWord++ = 0x0000;            // Std system dialog class
    u.pwStr = (1 + wcsecpy( u.pwStr, Caption ));
    if (Style & DS_SETFONT)
    {
        if HAVE_BITS( Style, DS_SHELLFONT ) Font = S_ShellFont; // Mandatory, so override arg.
        *u.pWord++ = Points;            // points
        u.pwStr = (1 + wcsecpy( u.pwStr, Font ));
    }
    return u.pItem;
}

LPDLGITEMTEMPLATE AddDlgItem( 
    LPDLGITEMTEMPLATE pBuf,
    DWORD   Type, 
    DWORD   Style, 
    DWORD   ExStyle, 
    short X, short Y, 
    short W, short H, 
    LPCWSTR Caption,
    WORD    Id
    )
{
    DitUniPtr u;
    u.pByte = dwAlign( (PBYTE) pBuf ); // align

    u.pItem->style = Style;
    u.pItem->dwExtendedStyle = ExStyle; //WS_EX_STATICEDGE;//WS_EX_WINDOWEDGE
    u.pItem->x = X;
    u.pItem->y = Y; 
    u.pItem->cx = W; 
    u.pItem->cy = H;
    u.pItem->id = Id;

    u.pItem++; // Past item header

    *u.pDword++ = Type; // E.g. ORD_STATIC;
    u.pwStr = (1 + wcsecpy( u.pwStr, Caption ));
    *u.pWord++ = 0; // No creation data
    return u.pItem;
}

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Extended dialog templates
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

PDLGTEMPLATEEX AllocExDlgTemplate( WORD Size )
{
    HGLOBAL hMem = GlobalAlloc( GHND, Size );
    return hMem ? (PDLGTEMPLATEEX) GlobalLock( hMem ) : NULL;
}
void FreeExDlgTemplate( PDLGTEMPLATEEX pDlg )
{
    GlobalFree( (HGLOBAL) pDlg );
}

typedef union _ditxUniPtr { // Local type
    PDLGITEMTEMPLATEEX  pItem;
    PBYTE               pByte;
    PWORD               pWord;
    PDWORD              pDword;
    PWSTR               pwStr;
  } DitXUniPtr;

PDLGITEMTEMPLATEEX SetExDlgStyle( 
    PDLGTEMPLATEEX pDlg, 
    DWORD   Style, 
    short X, short Y, 
    short W, short H,
    LPCWSTR Caption, 
    DWORD   HelpId,
    WORD    nCtls, 
    LPCWSTR Font, 
    short   Points,
    short   Weight,
    BYTE    CharSet
    )
{
    if (DWORD_PTR( pDlg ) & DWORD_PTR( 3 )) { // Check buffer alignment
        SetLastError( ERROR_INVALID_PARAMETER ); // Not DW aligned
        return NULL;
    }
    pDlg->dlgVer = 1;
    pDlg->signature = 0xffff;
    pDlg->helpId = HelpId;
    pDlg->exStyle = 0; // Currently not used for dialogs
    pDlg->style = Style;
    pDlg->cDlgItems = nCtls; 
    pDlg->x = X; // Dialog units..
    pDlg->y = Y;
    pDlg->cx = W;
    pDlg->cy = H;

    // Everything else in this structure is variable length,
    // and therefore must be determined dynamically

    DitXUniPtr u;
    u.pByte = PBYTE( pDlg+1 );      // Past the header

    // wsz_Or_Ord menu;         // Name or ordinal of a menu resource. 0x0000 = No menu
    // wsz_Or_Ord windowClass;  // Name or ordinal of a window class.  0x0000 = Std dialog class
    // WCHAR title[titleLen];   // Title string of the dialog box
    // short pointsize;         // Only if DS_SETFONT is set
    // short weight;            // -"-
    // uchar bItalic;           // -"-
    // uchar charSet;           // -"-
    // WCHAR font[fontLen];     // Typeface name, if DS_SETFONT is set

    *u.pWord++ = 0x0000;            // No menu
    *u.pWord++ = 0x0000;            // Std system dialog class
    u.pwStr = (1 + wcsecpy( u.pwStr, Caption ));

    if (Style & DS_SETFONT)
    {
        if HAVE_BITS( Style, DS_SHELLFONT ) Font = S_ShellFont; // Mandatory, so override arg.
        *u.pWord++ = Points;    // points
        *u.pWord++ = Weight;    // wight
        *u.pByte++ = 0;         // italic
        *u.pByte++ = CharSet;   // charset
        u.pwStr = (1 + wcsecpy( u.pwStr, Font ));
    }
    return u.pItem;
}

PDLGITEMTEMPLATEEX AddExDlgItem( 
    PDLGITEMTEMPLATEEX pBuf,
    DWORD   Type,
    DWORD   Style, 
    DWORD   ExStyle, 
    short X, short Y, 
    short W, short H, 
    LPCWSTR Caption,
    WORD    Id,
    DWORD   HelpId
    )
{
    DitXUniPtr u;
    u.pByte = dwAlign( (PBYTE) pBuf ); // align

    u.pItem->helpId = HelpId;
    u.pItem->exStyle = ExStyle;
    u.pItem->style = Style;
    u.pItem->x = X;
    u.pItem->y = Y; 
    u.pItem->cx = W; 
    u.pItem->cy = H;
    u.pItem->id = Id;

    // Everything else in this structure is variable length,
    // and therefore must be determined dynamically

    u.pItem++; // Past item header

    // wsz_Or_Ord ctrlClass;    // Name or ordinal of a control class
    // wsz_Or_Ord title;        // Title string or ordinal of a resource
    // WORD extraCount;         // Bytes following creation data

    *u.pDword++ = Type;         // E.g. ORD_STATIC;
    u.pwStr = (1 + wcsecpy( u.pwStr, Caption ));
    *u.pWord++ = 0;             // No creation data
    return u.pItem;
}

// EOF