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 "windef.h"
  29 #include "winbase.h"
  30 #include "winreg.h"
  31 #include "shlwapi.h"
  32
  33 #include "pidl.h"
  34 #include "shell32_main.h"
  35
  36 WINE_DEFAULT_DEBUG_CHANNEL(shell);
  37
  38 /**************************************************************************
  39  *  AddToEnumList()
  40  */
  41 BOOL AddToEnumList(IEnumIDListImpl *list, LPITEMIDLIST pidl)
  42 {
  43     struct pidl_enum_entry *pidl_entry;
  44
  45     TRACE("(%p)->(pidl=%p)\n", list, pidl);
  46
  47     if (!list || !pidl)
  48         return FALSE;
  49
  50     if (!(pidl_entry = SHAlloc(sizeof(*pidl_entry))))
  51         return FALSE;
  52
  53     pidl_entry->pidl = pidl;
  54     list_add_tail(&list->pidls, &pidl_entry->entry);
  55     if (!list->current)
  56         list->current = list_head(&list->pidls);
  57
  58     return TRUE;
  59 }
  60
  61 /**************************************************************************
  62  *  CreateFolderEnumList()
  63  */
  64 BOOL CreateFolderEnumList(IEnumIDListImpl *list, LPCWSTR lpszPath, DWORD dwFlags)
  65 {
  66     LPITEMIDLIST pidl=NULL;
  67     WIN32_FIND_DATAW stffile;
  68     HANDLE hFile;
  69     WCHAR  szPath[MAX_PATH];
  70     BOOL succeeded = TRUE;
  71
  72     TRACE("(%p)->(path=%s flags=0x%08lx)\n", list, debugstr_w(lpszPath), dwFlags);
  73
  74     if(!lpszPath || !lpszPath[0]) return FALSE;
  75
  76     lstrcpyW(szPath, lpszPath);
  77     PathAddBackslashW(szPath);
  78     lstrcatW(szPath,L"*");
  79
  80     hFile = FindFirstFileW(szPath,&stffile);
  81     if ( hFile != INVALID_HANDLE_VALUE )
  82     {
  83         BOOL findFinished = FALSE;
  84
  85         do
  86         {
  87             if ( !(stffile.dwFileAttributes & FILE_ATTRIBUTE_HIDDEN)
  88              || (dwFlags & SHCONTF_INCLUDEHIDDEN) )
  89             {
  90                 if ( (stffile.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) &&
  91                  dwFlags & SHCONTF_FOLDERS &&
  92                  wcscmp(stffile.cFileName, L".") && wcscmp(stffile.cFileName, L".."))
  93                 {
  94                     pidl = _ILCreateFromFindDataW(&stffile);
  95                     succeeded = succeeded && AddToEnumList(list, pidl);
  96                 }
  97                 else if (!(stffile.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
  98                  && dwFlags & SHCONTF_NONFOLDERS)
  99                 {
 100                     pidl = _ILCreateFromFindDataW(&stffile);
 101                     succeeded = succeeded && AddToEnumList(list, pidl);
 102                 }
 103             }
 104             if (succeeded)
 105             {
 106                 if (!FindNextFileW(hFile, &stffile))
 107                 {
 108                     if (GetLastError() == ERROR_NO_MORE_FILES)
 109                         findFinished = TRUE;
 110                     else
 111                         succeeded = FALSE;
 112                 }
 113             }
 114         } while (succeeded && !findFinished);
 115         FindClose(hFile);
 116     }
 117     return succeeded;
 118 }
 119
 120 static inline IEnumIDListImpl *impl_from_IEnumIDList(IEnumIDList *iface)
 121 {
 122     return CONTAINING_RECORD(iface, IEnumIDListImpl, IEnumIDList_iface);
 123 }
 124
 125 /**************************************************************************
 126  *  IEnumIDList::QueryInterface
 127  */
 128 static HRESULT WINAPI IEnumIDList_fnQueryInterface(IEnumIDList *iface, REFIID riid, void **ppvObj)
 129 {
 130     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 131
 132     TRACE("(%p)->(%s, %p)\n", This, debugstr_guid(riid), ppvObj);
 133
 134     *ppvObj = NULL;
 135
 136     if (IsEqualIID(riid, &IID_IUnknown) ||
 137         IsEqualIID(riid, &IID_IEnumIDList))
 138     {
 139         *ppvObj = &This->IEnumIDList_iface;
 140     }
 141
 142     if (*ppvObj)
 143     {
 144         IUnknown_AddRef((IUnknown*)*ppvObj);
 145         return S_OK;
 146     }
 147
 148     WARN("interface %s is not supported\n", debugstr_guid(riid));
 149     return E_NOINTERFACE;
 150 }
 151
 152 /******************************************************************************
 153  * IEnumIDList::AddRef
 154  */
 155 static ULONG WINAPI IEnumIDList_fnAddRef(IEnumIDList *iface)
 156 {
 157     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 158     ULONG refCount = InterlockedIncrement(&This->ref);
 159
 160     TRACE("(%p)->(%lu)\n", This, refCount - 1);
 161
 162     return refCount;
 163 }
 164
 165 /******************************************************************************
 166  * IEnumIDList::Release
 167  */
 168 static ULONG WINAPI IEnumIDList_fnRelease(IEnumIDList *iface)
 169 {
 170     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 171     ULONG refCount = InterlockedDecrement(&This->ref);
 172
 173     TRACE("(%p)->(%lu)\n", This, refCount + 1);
 174
 175     if (!refCount)
 176     {
 177         struct pidl_enum_entry *cur, *cur2;
 178
 179         LIST_FOR_EACH_ENTRY_SAFE(cur, cur2, &This->pidls, struct pidl_enum_entry, entry)
 180         {
 181             list_remove(&cur->entry);
 182             SHFree(cur->pidl);
 183             SHFree(cur);
 184         }
 185         free(This);
 186     }
 187
 188     return refCount;
 189 }
 190
 191 /**************************************************************************
 192  *  IEnumIDList::Next
 193  */
 194
 195 static HRESULT WINAPI IEnumIDList_fnNext(IEnumIDList *iface, ULONG celt, LPITEMIDLIST *rgelt,
 196         ULONG *fetched)
 197 {
 198     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 199     HRESULT hr = S_OK;
 200     ULONG i;
 201
 202     TRACE("(%p)->(%ld, %p, %p)\n", This, celt, rgelt, fetched);
 203
 204     /* It is valid to leave pceltFetched NULL when celt is 1. Some of explorer's
 205      * subsystems actually use it (and so may a third party browser)
 206      */
 207     if (fetched)
 208         *fetched = 0;
 209
 210     *rgelt = NULL;
 211
 212     if (celt > 1 && !fetched)
 213         return E_INVALIDARG;
 214
 215     if (celt > 0 && !This->current)
 216         return S_FALSE;
 217
 218     for (i = 0; i < celt; i++)
 219     {
 220         if (!This->current)
 221             break;
 222
 223         rgelt[i] = ILClone(LIST_ENTRY(This->current, struct pidl_enum_entry, entry)->pidl);
 224         This->current = list_next(&This->pidls, This->current);
 225     }
 226
 227     if (fetched)
 228         *fetched = i;
 229
 230     return hr;
 231 }
 232
 233 /**************************************************************************
 234 *  IEnumIDList::Skip
 235 */
 236 static HRESULT WINAPI IEnumIDList_fnSkip(IEnumIDList *iface, ULONG celt)
 237 {
 238     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 239     HRESULT hr = S_OK;
 240     ULONG i;
 241
 242     TRACE("(%p)->(%lu)\n", This, celt);
 243
 244     for (i = 0; i < celt; i++)
 245     {
 246         if (!This->current)
 247         {
 248             hr = S_FALSE;
 249             break;
 250         }
 251         This->current = list_next(&This->pidls, This->current);
 252     }
 253
 254     return hr;
 255 }
 256
 257 /**************************************************************************
 258 *  IEnumIDList::Reset
 259 */
 260 static HRESULT WINAPI IEnumIDList_fnReset(IEnumIDList *iface)
 261 {
 262     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 263
 264     TRACE("(%p)\n",This);
 265     This->current = list_head(&This->pidls);
 266     return S_OK;
 267 }
 268
 269 /**************************************************************************
 270 *  IEnumIDList::Clone
 271 */
 272 static HRESULT WINAPI IEnumIDList_fnClone(IEnumIDList *iface, IEnumIDList **ppenum)
 273 {
 274     IEnumIDListImpl *This = impl_from_IEnumIDList(iface);
 275
 276     FIXME("(%p)->(%p): stub\n",This, ppenum);
 277
 278     return E_NOTIMPL;
 279 }
 280
 281 static const IEnumIDListVtbl eidlvt =
 282 {
 283     IEnumIDList_fnQueryInterface,
 284     IEnumIDList_fnAddRef,
 285     IEnumIDList_fnRelease,
 286     IEnumIDList_fnNext,
 287     IEnumIDList_fnSkip,
 288     IEnumIDList_fnReset,
 289     IEnumIDList_fnClone,
 290 };
 291
 292 IEnumIDListImpl *IEnumIDList_Constructor(void)
 293 {
 294     IEnumIDListImpl *lpeidl = malloc(sizeof(*lpeidl));
 295
 296     if (lpeidl)
 297     {
 298         lpeidl->IEnumIDList_iface.lpVtbl = &eidlvt;
 299         lpeidl->ref = 1;
 300         list_init(&lpeidl->pidls);
 301         lpeidl->current = NULL;
 302     }
 303
 304     TRACE("-- (%p)->()\n",lpeidl);
 305
 306     return lpeidl;
 307 }