dlls/shell32/enumidlist.c

   1 /*
   2  *      IEnumIDList
   3  *
   4  *      Copyright 1998  Juergen Schmied <juergen.schmied@metronet.de>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <stdarg.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24
  25 #define COBJMACROS
  26
  27 #include "wine/debug.h"
  28 #include "wine/unicode.h"
  29 #include "windef.h"
  30 #include "winbase.h"
  31 #include "winreg.h"
  32 #include "shlwapi.h"
  33
  34 #include "pidl.h"
  35 #include "shell32_main.h"
  36
  37 WINE_DEFAULT_DEBUG_CHANNEL(shell);
  38
  39 /**************************************************************************
  40  *  AddToEnumList()
  41  */
  42 BOOL AddToEnumList(IEnumIDListImpl *list, LPITEMIDLIST pidl)
  43 {
  44     struct pidl_enum_entry *pidl_entry;
  45
  46     TRACE("(%p)->(pidl=%p)\n", list, pidl);
  47
  48     if (!list || !pidl)
  49         return FALSE;
  50
  51     if (!(pidl_entry = SHAlloc(sizeof(*pidl_entry))))
  52         return FALSE;
  53
  54     pidl_entry->pidl = pidl;
  55     list_add_tail(&list->pidls, &pidl_entry->entry);
  56     if (!list->current)
  57         list->current = list_head(&list->pidls);
  58
  59     return TRUE;
  60 }
  61
  62 /**************************************************************************
  63  *  CreateFolderEnumList()
  64  */
  65 BOOL CreateFolderEnumList(IEnumIDListImpl *list, LPCWSTR lpszPath, DWORD dwFlags)
  66 {
  67     LPITEMIDLIST pidl=NULL;
  68     WIN32_FIND_DATAW stffile;
  69     HANDLE hFile;
  70     WCHAR  szPath[MAX_PATH];
  71     BOOL succeeded = TRUE;
  72     static const WCHAR stars[] = { '*','.','*',0 };
  73     static const WCHAR dot[] = { '.',0 };
  74     static const WCHAR dotdot[] = { '.','.',0 };
  75
  76     TRACE("(%p)->(path=%s flags=0x%08x)\n", list, debugstr_w(lpszPath), dwFlags);
  77
  78     if(!lpszPath || !lpszPath[0]) return FALSE;
  79
  80     strcpyW(szPath, lpszPath);
  81     PathAddBackslashW(szPath);
  82     strcatW(szPath,stars);
  83
  84     hFile = FindFirstFileW(szPath,&stffile);
  85     if ( hFile != INVALID_HANDLE_VALUE )
  86     {
  87         BOOL findFinished = FALSE;
  88
  89         do
  90         {
  91             if ( !(stffile.dwFileAttributes & FILE_ATTRIBUTE_HIDDEN)
  92              || (dwFlags & SHCONTF_INCLUDEHIDDEN) )
  93             {
  94                 if ( (stffile.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) &&
  95                  dwFlags & SHCONTF_FOLDERS &&
  96                  strcmpW(stffile.cFileName, dot) && strcmpW(stffile.cFileName, dotdot))
  97                 {
  98                     pidl = _ILCreateFromFindDataW(&stffile);
  99                     succeeded = succeeded && AddToEnumList(list, pidl);
 100                 }
 101                 else if (!(stffile.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
 102                  && dwFlags & SHCONTF_NONFOLDERS)
 103                 {
 104                     pidl = _ILCreateFromFindDataW(&stffile);
 105                     succeeded = succeeded && AddToEnumList(list, pidl);
 106                 }
 107             }
 108             if (succeeded)
 109             {
 110                 if (!FindNextFileW(hFile, &stffile))
 111                 {
 112                     if (GetLastError() == ERROR_NO_MORE_FILES)
 113                         findFinished = TRUE;
 114                     else
 115                         succeeded = FALSE;
 116                 }
 117             }
 118         } while (succeeded && !findFinished);
 119         FindClose(hFile);
 120     }
 121     return succeeded;
 122 }
 123
 124 static inline IEnumIDListImpl *impl_from_IEnumIDList(IEnumIDList *iface)
 125 {
 126     return CONTAINING_RECORD(iface, IEnumIDListImpl, IEnumIDList_iface);
 127 }
 128
 129 /**************************************************************************
 130  *  IEnumIDList::QueryInterface
 131  */
 132 static HRESULT WINAPI IEnumIDList_fnQueryInterface(IEnumIDList *iface, REFIID riid, void **ppvObj)
 133 {
 134     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 135
 136     TRACE("(%p)->(%s, %p)\n", This, debugstr_guid(riid), ppvObj);
 137
 138     *ppvObj = NULL;
 139
 140     if (IsEqualIID(riid, &IID_IUnknown) ||
 141         IsEqualIID(riid, &IID_IEnumIDList))
 142     {
 143         *ppvObj = &This->IEnumIDList_iface;
 144     }
 145
 146     if (*ppvObj)
 147     {
 148         IUnknown_AddRef((IUnknown*)*ppvObj);
 149         return S_OK;
 150     }
 151
 152     WARN("interface %s is not supported\n", debugstr_guid(riid));
 153     return E_NOINTERFACE;
 154 }
 155
 156 /******************************************************************************
 157  * IEnumIDList::AddRef
 158  */
 159 static ULONG WINAPI IEnumIDList_fnAddRef(IEnumIDList *iface)
 160 {
 161     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 162     ULONG refCount = InterlockedIncrement(&This->ref);
 163
 164     TRACE("(%p)->(%u)\n", This, refCount - 1);
 165
 166     return refCount;
 167 }
 168
 169 /******************************************************************************
 170  * IEnumIDList::Release
 171  */
 172 static ULONG WINAPI IEnumIDList_fnRelease(IEnumIDList *iface)
 173 {
 174     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 175     ULONG refCount = InterlockedDecrement(&This->ref);
 176
 177     TRACE("(%p)->(%u)\n", This, refCount + 1);
 178
 179     if (!refCount)
 180     {
 181         struct pidl_enum_entry *cur, *cur2;
 182
 183         LIST_FOR_EACH_ENTRY_SAFE(cur, cur2, &This->pidls, struct pidl_enum_entry, entry)
 184         {
 185             list_remove(&cur->entry);
 186             SHFree(cur->pidl);
 187             SHFree(cur);
 188         }
 189         heap_free(This);
 190     }
 191
 192     return refCount;
 193 }
 194
 195 /**************************************************************************
 196  *  IEnumIDList::Next
 197  */
 198
 199 static HRESULT WINAPI IEnumIDList_fnNext(IEnumIDList *iface, ULONG celt, LPITEMIDLIST *rgelt,
 200         ULONG *fetched)
 201 {
 202     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 203     HRESULT hr = S_OK;
 204     ULONG i;
 205
 206     TRACE("(%p)->(%d, %p, %p)\n", This, celt, rgelt, fetched);
 207
 208     /* It is valid to leave pceltFetched NULL when celt is 1. Some of explorer's
 209      * subsystems actually use it (and so may a third party browser)
 210      */
 211     if (fetched)
 212         *fetched = 0;
 213
 214     *rgelt = NULL;
 215
 216     if (celt > 1 && !fetched)
 217         return E_INVALIDARG;
 218
 219     if (celt > 0 && !This->current)
 220         return S_FALSE;
 221
 222     for (i = 0; i < celt; i++)
 223     {
 224         if (!This->current)
 225             break;
 226
 227         rgelt[i] = ILClone(LIST_ENTRY(This->current, struct pidl_enum_entry, entry)->pidl);
 228         This->current = list_next(&This->pidls, This->current);
 229     }
 230
 231     if (fetched)
 232         *fetched = i;
 233
 234     return hr;
 235 }
 236
 237 /**************************************************************************
 238 *  IEnumIDList::Skip
 239 */
 240 static HRESULT WINAPI IEnumIDList_fnSkip(IEnumIDList *iface, ULONG celt)
 241 {
 242     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 243     HRESULT hr = S_OK;
 244     ULONG i;
 245
 246     TRACE("(%p)->(%u)\n", This, celt);
 247
 248     for (i = 0; i < celt; i++)
 249     {
 250         if (!This->current)
 251         {
 252             hr = S_FALSE;
 253             break;
 254         }
 255         This->current = list_next(&This->pidls, This->current);
 256     }
 257
 258     return hr;
 259 }
 260
 261 /**************************************************************************
 262 *  IEnumIDList::Reset
 263 */
 264 static HRESULT WINAPI IEnumIDList_fnReset(IEnumIDList *iface)
 265 {
 266     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 267
 268     TRACE("(%p)\n",This);
 269     This->current = list_head(&This->pidls);
 270     return S_OK;
 271 }
 272
 273 /**************************************************************************
 274 *  IEnumIDList::Clone
 275 */
 276 static HRESULT WINAPI IEnumIDList_fnClone(IEnumIDList *iface, IEnumIDList **ppenum)
 277 {
 278     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 279
 280     FIXME("(%p)->(%p): stub\n",This, ppenum);
 281
 282     return E_NOTIMPL;
 283 }
 284
 285 static const IEnumIDListVtbl eidlvt =
 286 {
 287     IEnumIDList_fnQueryInterface,
 288     IEnumIDList_fnAddRef,
 289     IEnumIDList_fnRelease,
 290     IEnumIDList_fnNext,
 291     IEnumIDList_fnSkip,
 292     IEnumIDList_fnReset,
 293     IEnumIDList_fnClone,
 294 };
 295
 296 IEnumIDListImpl *IEnumIDList_Constructor(void)
 297 {
 298     IEnumIDListImpl *lpeidl = heap_alloc(sizeof(*lpeidl));
 299
 300     if (lpeidl)
 301     {
 302         lpeidl->IEnumIDList_iface.lpVtbl = &eidlvt;
 303         lpeidl->ref = 1;
 304         list_init(&lpeidl->pidls);
 305         lpeidl->current = NULL;
 306     }
 307
 308     TRACE("-- (%p)->()\n",lpeidl);
 309
 310     return lpeidl;
 311 }