ReactOS 0.4.16-dev-1151-g3842b59
shellutils.h File Reference

Go to the source code of this file.

Macros

#define DbgPrint(fmt, ...)    Win32DbgPrint(__FILE__, __LINE__, fmt, ##__VA_ARGS__)
 
#define IID_PPV_ARG(Itype, ppType)   &IID_##Itype, (void**)(ppType)
 
#define IID_NULL_PPV_ARG(Itype, ppType)   &IID_##Itype, NULL, (void**)(ppType)
 
#define FAILED_UNEXPECTEDLY(hr)   _ROS_FAILED_HELPER((hr), #hr, __FILE__, __LINE__)
 
#define SHELL_ErrorBox   SHELL_ErrorBoxHelper
 
#define S_LESSTHAN   0xffff
 
#define S_EQUAL   S_OK
 
#define S_GREATERTHAN   S_FALSE
 
#define MAKE_COMPARE_HRESULT(x)   ((x)>0 ? S_GREATERTHAN : ((x)<0 ? S_LESSTHAN : S_EQUAL))
 
#define SEE_CMIC_COMMON_BASICFLAGS
 
#define SEE_CMIC_COMMON_FLAGS
 
#define SHELL_GetSetting(pss, ssf, field)   ( SHGetSetSettings((pss), (ssf), FALSE), (pss)->field )
 

Functions

static ULONG Win32DbgPrint (const char *filename, int line, const char *lpFormat,...)
 
static HRESULT HResultFromWin32 (DWORD hr)
 
static BOOL _ROS_FAILED_HELPER (HRESULT hr, const char *expr, const char *filename, int line)
 
static UINT SHELL_ErrorBoxHelper (HWND hwndOwner, UINT Error)
 
static BOOL SHELL_IsContextMenuMsg (UINT uMsg)
 
static BOOL ILIsSingle (LPCITEMIDLIST pidl)
 
static PCUIDLIST_ABSOLUTE HIDA_GetPIDLFolder (CIDA const *pida)
 
static PCUIDLIST_RELATIVE HIDA_GetPIDLItem (CIDA const *pida, SIZE_T i)
 
static void DumpIdListOneLine (LPCITEMIDLIST pidl)
 

Macro Definition Documentation

◆ DbgPrint

#define DbgPrint (   fmt,
  ... 
)     Win32DbgPrint(__FILE__, __LINE__, fmt, ##__VA_ARGS__)

Definition at line 59 of file shellutils.h.

◆ FAILED_UNEXPECTEDLY

#define FAILED_UNEXPECTEDLY (   hr)    _ROS_FAILED_HELPER((hr), #hr, __FILE__, __LINE__)

Definition at line 88 of file shellutils.h.

◆ IID_NULL_PPV_ARG

#define IID_NULL_PPV_ARG (   Itype,
  ppType 
)    &IID_##Itype, NULL, (void**)(ppType)

Definition at line 67 of file shellutils.h.

◆ IID_PPV_ARG

#define IID_PPV_ARG (   Itype,
  ppType 
)    &IID_##Itype, (void**)(ppType)

Definition at line 66 of file shellutils.h.

◆ MAKE_COMPARE_HRESULT

#define MAKE_COMPARE_HRESULT (   x)    ((x)>0 ? S_GREATERTHAN : ((x)<0 ? S_LESSTHAN : S_EQUAL))

Definition at line 630 of file shellutils.h.

◆ S_EQUAL

#define S_EQUAL   S_OK

Definition at line 628 of file shellutils.h.

◆ S_GREATERTHAN

#define S_GREATERTHAN   S_FALSE

Definition at line 629 of file shellutils.h.

◆ S_LESSTHAN

#define S_LESSTHAN   0xffff

Definition at line 627 of file shellutils.h.

◆ SEE_CMIC_COMMON_BASICFLAGS

#define SEE_CMIC_COMMON_BASICFLAGS
Value:
#define SEE_MASK_FLAG_LOG_USAGE
Definition: shellapi.h:59
#define SEE_MASK_FLAG_SEPVDM
Definition: shellapi.h:50
#define SEE_MASK_UNICODE
Definition: shellapi.h:37
#define SEE_MASK_ASYNCOK
Definition: shellapi.h:54
#define SEE_MASK_NOASYNC
Definition: shellapi.h:33
#define SEE_MASK_NOZONECHECKS
Definition: shellapi.h:56
#define SEE_MASK_FLAG_NO_UI
Definition: shellapi.h:36
#define SEE_MASK_NO_CONSOLE
Definition: shellapi.h:38

Definition at line 632 of file shellutils.h.

◆ SEE_CMIC_COMMON_FLAGS

#define SEE_CMIC_COMMON_FLAGS
Value:
#define SEE_MASK_ICON
Definition: shellapi.h:29
#define SEE_MASK_HOTKEY
Definition: shellapi.h:30
#define SEE_MASK_HASTITLE
Definition: shellapi.h:52
#define SEE_MASK_HASLINKNAME
Definition: shellapi.h:49
#define SEE_CMIC_COMMON_BASICFLAGS
Definition: shellutils.h:632

Definition at line 635 of file shellutils.h.

◆ SHELL_ErrorBox

#define SHELL_ErrorBox   SHELL_ErrorBoxHelper

Definition at line 126 of file shellutils.h.

◆ SHELL_GetSetting

#define SHELL_GetSetting (   pss,
  ssf,
  field 
)    ( SHGetSetSettings((pss), (ssf), FALSE), (pss)->field )

Definition at line 843 of file shellutils.h.

Function Documentation

◆ _ROS_FAILED_HELPER()

static BOOL _ROS_FAILED_HELPER ( HRESULT  hr,
const char expr,
const char filename,
int  line 
)
inlinestatic

Definition at line 78 of file shellutils.h.

79{
80 if (FAILED(hr))
81 {
82 Win32DbgPrint(filename, line, "Unexpected failure (%s)=%08x.\n", expr, hr);
83 return TRUE;
84 }
85 return FALSE;
86}
#define TRUE
Definition: types.h:120
#define FALSE
Definition: types.h:117
#define FAILED(hr)
Definition: intsafe.h:51
const char * filename
Definition: ioapi.h:137
static ULONG Win32DbgPrint(const char *filename, int line, const char *lpFormat,...)
Definition: shellutils.h:27
HRESULT hr
Definition: shlfolder.c:183
Definition: query.h:86
Definition: parser.c:49

◆ DumpIdListOneLine()

static void DumpIdListOneLine ( LPCITEMIDLIST  pidl)
inlinestatic

Definition at line 846 of file shellutils.h.

847{
848 char buf[1024], *data, drive = 0;
849 for (UINT depth = 0, type; ; pidl = ILGetNext(pidl), ++depth)
850 {
851 if (!pidl || !pidl->mkid.cb)
852 {
853 if (!depth)
854 {
855 wsprintfA(buf, "%p [] (%s)\n", pidl, pidl ? "Empty/Desktop" : "NULL");
857 }
858 break;
859 }
860 else if (!depth)
861 {
862 wsprintfA(buf, "%p", pidl);
864 }
865 type = pidl->mkid.abID[0] & 0x7f;
866 data = (char*)&pidl->mkid.abID[0];
867 if (depth == 0 && type == 0x1f && pidl->mkid.cb == 20 && *(UINT*)(&data[2]) == 0x20D04FE0)
868 {
869 wsprintfA(buf, " [%.2x ThisPC?]", type); /* "?" because we did not check the full GUID */
870 }
871 else if (depth == 1 && type >= 0x20 && type < 0x30 && type != 0x2E && pidl->mkid.cb > 4)
872 {
873 drive = data[1];
874 wsprintfA(buf, " [%.2x %c: %ub]", type, drive, pidl->mkid.cb);
875 }
876 else if (depth >= 2 && drive && (type & 0x70) == 0x30) /* PT_FS */
877 {
878 if (type & 4)
879 wsprintfA(buf, " [%.2x FS %.256ls %ub]", type, data + 12, pidl->mkid.cb);
880 else
881 wsprintfA(buf, " [%.2x FS %.256hs %ub]", type, data + 12, pidl->mkid.cb);
882 }
883 else
884 {
885 wsprintfA(buf, " [%.2x ? %ub]", type, pidl->mkid.cb);
886 }
888 }
889 OutputDebugStringA("\n");
890}
GLint GLint GLsizei GLsizei GLsizei depth
Definition: gl.h:1546
GLuint GLuint GLsizei GLenum type
Definition: gl.h:1545
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: gl.h:1950
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glext.h:7751
void WINAPI SHIM_OBJ_NAME() OutputDebugStringA(LPCSTR lpOutputString)
Definition: ignoredbgout.c:18
if(dx< 0)
Definition: linetemp.h:194
unsigned int UINT
Definition: ndis.h:50
LPITEMIDLIST WINAPI ILGetNext(LPCITEMIDLIST pidl)
Definition: pidl.c:970
int WINAPIV wsprintfA(_Out_ LPSTR, _In_ _Printf_format_string_ LPCSTR,...)

◆ HIDA_GetPIDLFolder()

static PCUIDLIST_ABSOLUTE HIDA_GetPIDLFolder ( CIDA const pida)
inlinestatic

Definition at line 649 of file shellutils.h.

650{
651 return (PCUIDLIST_ABSOLUTE)(((LPBYTE)pida) + (pida)->aoffset[0]);
652}
const ITEMIDLIST_ABSOLUTE UNALIGNED * PCUIDLIST_ABSOLUTE
Definition: shtypes.idl:63
unsigned char * LPBYTE
Definition: typedefs.h:53

Referenced by CFontExt::Drop(), CMyDocsDropHandler::Drop(), CDeskLinkDropHandler::Drop(), CShellItemArray::GetItemAt(), COpenWithMenu::Initialize(), SHELL_CIDA_ILCloneFull(), SHELL_CloneDataObject(), SHGetAttributesFromDataObject(), and TestHIDA().

◆ HIDA_GetPIDLItem()

static PCUIDLIST_RELATIVE HIDA_GetPIDLItem ( CIDA const pida,
SIZE_T  i 
)
inlinestatic

Definition at line 654 of file shellutils.h.

655{
656 return (PCUIDLIST_RELATIVE)(((LPBYTE)pida) + (pida)->aoffset[i + 1]);
657}
GLsizei GLenum const GLvoid GLsizei GLenum GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLint GLint GLint GLshort GLshort GLshort GLubyte GLubyte GLubyte GLuint GLuint GLuint GLushort GLushort GLushort GLbyte GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLfloat GLint GLint GLint GLint GLshort GLshort GLshort GLshort GLubyte GLubyte GLubyte GLubyte GLuint GLuint GLuint GLuint GLushort GLushort GLushort GLushort GLboolean const GLdouble const GLfloat const GLint const GLshort const GLbyte const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLdouble const GLfloat const GLfloat const GLint const GLint const GLshort const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort GLenum GLenum GLenum GLfloat GLenum GLint GLenum GLenum GLenum GLfloat GLenum GLenum GLint GLenum GLfloat GLenum GLint GLint GLushort GLenum GLenum GLfloat GLenum GLenum GLint GLfloat const GLubyte GLenum GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLint GLint GLsizei GLsizei GLint GLenum GLenum const GLvoid GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLenum const GLdouble GLenum GLenum const GLfloat GLenum GLenum const GLint GLsizei GLuint GLfloat GLuint GLbitfield GLfloat GLint GLuint GLboolean GLenum GLfloat GLenum GLbitfield GLenum GLfloat GLfloat GLint GLint const GLfloat GLenum GLfloat GLfloat GLint GLint GLfloat GLfloat GLint GLint const GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat const GLdouble const GLfloat const GLdouble const GLfloat GLint i
Definition: glfuncs.h:248
const ITEMIDLIST_RELATIVE UNALIGNED * PCUIDLIST_RELATIVE
Definition: shtypes.idl:57

Referenced by CFontExt::Drop(), CMyDocsDropHandler::Drop(), CDeskLinkDropHandler::Drop(), ExtractFilesCallback(), FontFolderMenuCallback(), FSFolderItemPropDialogInitCallback(), CShellItemArray::GetItemAt(), COpenWithMenu::Initialize(), SHELL32_ShowFilesystemItemPropertiesDialogAsync(), SHELL_CIDA_ILCloneFull(), SHGetAttributesFromDataObject(), and TestHIDA().

◆ HResultFromWin32()

static HRESULT HResultFromWin32 ( DWORD  hr)
inlinestatic

Definition at line 70 of file shellutils.h.

71{
72 // HRESULT_FROM_WIN32 will evaluate its parameter twice, this function will not.
73 return HRESULT_FROM_WIN32(hr);
74}
#define HRESULT_FROM_WIN32(x)
Definition: winerror.h:92

◆ ILIsSingle()

static BOOL ILIsSingle ( LPCITEMIDLIST  pidl)
inlinestatic

Definition at line 644 of file shellutils.h.

645{
646 return pidl == ILFindLastID(pidl);
647}
LPITEMIDLIST WINAPI ILFindLastID(LPCITEMIDLIST pidl)
Definition: pidl.c:198

Referenced by CCabFolder::CompareIDs(), and SHOpenFolderAndSelectItems().

◆ SHELL_ErrorBoxHelper()

static UINT SHELL_ErrorBoxHelper ( HWND  hwndOwner,
UINT  Error 
)
inlinestatic

Definition at line 98 of file shellutils.h.

99{
100 WCHAR buf[400];
101 UINT cch;
102
103 if (!IsWindowVisible(hwndOwner))
104 hwndOwner = NULL;
105 if (Error == ERROR_SUCCESS)
107
109 NULL, Error, 0, buf, _countof(buf), NULL);
110 if (!cch)
111 {
112 enum { user32_IDS_ERROR = 2 }; // IDS_ERROR from user32 resource.h ("Error" string)
113 cch = LoadStringW(LoadLibraryW(L"USER32"), user32_IDS_ERROR, buf, _countof(buf));
114 wsprintfW(buf + cch, L"\n\n%#x (%d)", Error, Error);
115 }
116 MessageBoxW(hwndOwner, buf, NULL, MB_OK | MB_ICONSTOP);
117 return Error;
118}
BOOL Error
Definition: chkdsk.c:66
#define ERROR_SUCCESS
Definition: deptool.c:10
#define NULL
Definition: types.h:112
#define LoadLibraryW(x)
Definition: compat.h:747
DWORD WINAPI FormatMessageW(DWORD dwFlags, LPCVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, LPWSTR lpBuffer, DWORD nSize, __ms_va_list *args)
Definition: format_msg.c:583
static DWORD DWORD void LPSTR DWORD cch
Definition: str.c:202
#define L(x)
Definition: ntvdm.h:50
#define _countof(array)
Definition: sndvol32.h:70
#define FORMAT_MESSAGE_IGNORE_INSERTS
Definition: winbase.h:446
#define FORMAT_MESSAGE_FROM_SYSTEM
Definition: winbase.h:449
#define ERROR_INTERNAL_ERROR
Definition: winerror.h:840
int WINAPI LoadStringW(_In_opt_ HINSTANCE hInstance, _In_ UINT uID, _Out_writes_to_(cchBufferMax, return+1) LPWSTR lpBuffer, _In_ int cchBufferMax)
int WINAPIV wsprintfW(_Out_ LPWSTR, _In_ _Printf_format_string_ LPCWSTR,...)
int WINAPI MessageBoxW(_In_opt_ HWND hWnd, _In_opt_ LPCWSTR lpText, _In_opt_ LPCWSTR lpCaption, _In_ UINT uType)
#define MB_OK
Definition: winuser.h:801
#define MB_ICONSTOP
Definition: winuser.h:814
BOOL WINAPI IsWindowVisible(_In_ HWND)
__wchar_t WCHAR
Definition: xmlstorage.h:180

◆ SHELL_IsContextMenuMsg()

static BOOL SHELL_IsContextMenuMsg ( UINT  uMsg)
inlinestatic

Definition at line 638 of file shellutils.h.

639{
640 return uMsg == WM_MEASUREITEM || uMsg == WM_DRAWITEM ||
641 uMsg == WM_INITMENUPOPUP || uMsg == WM_MENUSELECT || uMsg == WM_MENUCHAR;
642}
#define WM_DRAWITEM
Definition: winuser.h:1656
#define WM_MENUCHAR
Definition: winuser.h:1759
#define WM_INITMENUPOPUP
Definition: winuser.h:1757
#define WM_MEASUREITEM
Definition: winuser.h:1657
#define WM_MENUSELECT
Definition: winuser.h:1758

Referenced by BrFolderDlgProc(), and CDefaultContextMenu::HandleMenuMsg2().

◆ Win32DbgPrint()

static ULONG Win32DbgPrint ( const char filename,
int  line,
const char lpFormat,
  ... 
)
inlinestatic

Definition at line 27 of file shellutils.h.

28{
29 char szMsg[512];
30 char *szMsgStart;
31 const char *fname;
32 va_list vl;
33
34 fname = strrchr(filename, '\\');
35 if (fname == NULL)
36 {
37 fname = strrchr(filename, '/');
38 if (fname != NULL)
39 fname++;
40 }
41 else
42 fname++;
43
44 if (fname == NULL)
45 fname = filename;
46
47 szMsgStart = szMsg + sprintf(szMsg, "%s:%d: ", fname, line);
48
49 va_start(vl, lpFormat);
50 vsprintf(szMsgStart, lpFormat, vl);
51 va_end(vl);
52
53 OutputDebugStringA(szMsg);
54
55 /* Return STATUS_SUCCESS, since we are supposed to mimic DbgPrint */
56 return 0;
57}
char * va_list
Definition: acmsvcex.h:78
#define va_end(ap)
Definition: acmsvcex.h:90
#define va_start(ap, A)
Definition: acmsvcex.h:91
int __cdecl vsprintf(char *_Dest, const char *_Format, va_list _Args)
Definition: sprintf.c:733
#define sprintf(buf, format,...)
Definition: sprintf.c:55
_CRT_RESTORE_GCC_WARNINGS _CRT_DISABLE_GCC_WARNINGS _Check_return_ _CRTIMP _CONST_RETURN char *__cdecl strrchr(_In_z_ const char *_Str, _In_ int _Ch)
LPCWSTR lpFormat
Definition: trayclock.cpp:32

Referenced by _ROS_FAILED_HELPER().