Entry Struct Reference

base of all file and directory entries More...

#include <entries.h>

Inheritance diagram for Entry:

Collaboration diagram for Entry:

Public Member Functions
virtual	~Entry ()
void	free_subentries ()
void	read_directory_base (SORT_ORDER sortOrder=SORT_NAME, int scan_flags=0)
Entry *	read_tree (const void *path, SORT_ORDER sortOrder=SORT_NAME, int scan_flags=0)
void	sort_directory (SORT_ORDER sortOrder)
void	smart_scan (SORT_ORDER sortOrder=SORT_NAME, int scan_flags=0)
int	extract_icon (ICONCACHE_FLAGS flags=ICF_NORMAL)
int	safe_extract_icon (ICONCACHE_FLAGS flags=ICF_NORMAL)
virtual void	read_directory (int scan_flags=0)
virtual const void *	get_next_path_component (const void *) const
virtual Entry *	find_entry (const void *)
virtual bool	get_path (PTSTR path, size_t path_count) const =0
virtual ShellPath	create_absolute_pidl () const
virtual HRESULT	GetUIObjectOf (HWND hWnd, REFIID riid, LPVOID *ppvOut)
virtual ShellFolder	get_shell_folder () const
virtual BOOL	launch_entry (HWND hwnd, UINT nCmdShow=SW_SHOWNORMAL)
virtual HRESULT	do_context_menu (HWND hwnd, const POINT &pos, CtxMenuInterfaces &cm_ifs)

Public Attributes
Entry *	_next
Entry *	_down
Entry *	_up
bool	_expanded
bool	_scanned
int	_level
WIN32_FIND_DATA	_data
SFGAOF	_shell_attribs
LPTSTR	_display_name
LPTSTR	_type_name
LPTSTR	_content
ENTRY_TYPE	_etype
int	_icon_id
BY_HANDLE_FILE_INFORMATION	_bhfi
bool	_bhfi_valid

Protected Member Functions
	Entry (ENTRY_TYPE etype)
	Entry (Entry *parent, ENTRY_TYPE etype)
	Entry (const Entry &)
bool	get_path_base (PTSTR path, size_t path_count, ENTRY_TYPE etype) const

Detailed Description

base of all file and directory entries

Definition at line 82 of file entries.h.

Constructor & Destructor Documentation

Entry() [1/3]

Entry::Entry ( ENTRY_TYPE  etype )

protected

Definition at line 35 of file entries.cpp.

 :  _etype(etype)
{
    _up = NULL;
    _next = NULL;
    _down = NULL;
    _expanded = false;
    _scanned = false;
    _bhfi_valid = false;
    _level = 0;
    _icon_id = ICID_UNKNOWN;
    _display_name = _data.cFileName;
    _type_name = NULL;
    _content = NULL;
}

Referenced by AppendGenericListEntry(), CenterCurrentListItem(), ClasspInsertCScanList(), DoLAYOUT(), EventCallback(), GetNextListEntry(), KspAddCreateItemToList(), KspCreateDeviceReference(), KspQueryBusRelations(), ScrollDownGenericList(), ScrollToPositionGenericList(), ScrollUpGenericList(), SmpConfigureSubSystems(), SmpSaveRegistryValue(), WdmAudOpenSysAudioDeviceInterfaces(), and WdmAudOpenSysAudioDevices().

Entry() [2/3]

Entry::Entry ( Entry *  parent, ENTRY_TYPE  etype  )

protected

Definition at line 51 of file entries.cpp.

 :  _up(parent),
    _etype(etype)
{
    _next = NULL;
    _down = NULL;
    _expanded = false;
    _scanned = false;
    _bhfi_valid = false;
    _level = 0;
    _icon_id = ICID_UNKNOWN;
    _shell_attribs = 0;
    _display_name = _data.cFileName;
    _type_name = NULL;
    _content = NULL;
}

Entry() [3/3]

Entry::Entry ( const Entry &  other )

protected

Definition at line 68 of file entries.cpp.

{
    _next = NULL;
    _down = NULL;
    _up = NULL;
 
    assert(!other._next);
    assert(!other._down);
    assert(!other._up);
 
    _expanded = other._expanded;
    _scanned = other._scanned;
    _level = other._level;
 
    _data = other._data;
 
    _shell_attribs = other._shell_attribs;
    _display_name = other._display_name==other._data.cFileName? _data.cFileName: _tcsdup(other._display_name);
    _type_name = other._type_name? _tcsdup(other._type_name): NULL;
    _content = other._content? _tcsdup(other._content): NULL;
 
    _etype = other._etype;
    _icon_id = other._icon_id;
 
    _bhfi = other._bhfi;
    _bhfi_valid = other._bhfi_valid;
}

~Entry()

Entry::~Entry ( )

virtual

Definition at line 97 of file entries.cpp.

{
    free_subentries();
 
    if (_icon_id > ICID_NONE)
        g_Globals._icon_cache.free_icon(_icon_id);
 
    if (_display_name != _data.cFileName)
        free(_display_name);
 
    if (_type_name)
        free(_type_name);
 
    if (_content)
        free(_content);
 
    if (_down)
        delete _down;
}

Member Function Documentation

create_absolute_pidl()

virtual ShellPath Entry::create_absolute_pidl ( ) const

inlinevirtual

Reimplemented in FATEntry, ShellEntry, and WinEntry.

Definition at line 126 of file entries.h.

{return (LPCITEMIDLIST)NULL;}

Referenced by ShellEntry::create_absolute_pidl(), do_context_menu(), extract_icon(), and get_shell_folder().

do_context_menu()

HRESULT Entry::do_context_menu ( HWND  hwnd, const POINT &  pos, CtxMenuInterfaces &  cm_ifs  )

virtual

Reimplemented in ShellEntry.

Definition at line 519 of file entries.cpp.

{
    ShellPath shell_path = create_absolute_pidl();
    LPCITEMIDLIST pidl_abs = shell_path;
 
    if (!pidl_abs)
        return S_FALSE; // no action for registry entries, etc.
 
#ifdef USE_MY_SHBINDTOPARENT
    IShellFolder* parentFolder;
    LPCITEMIDLIST pidlLast;
 
     // get and use the parent folder to display correct context menu in all cases -> correct "Properties" dialog for directories, ...
    HRESULT hr = my_SHBindToParent(pidl_abs, IID_IShellFolder, (LPVOID*)&parentFolder, &pidlLast);
 
    if (SUCCEEDED(hr)) {
        hr = ShellFolderContextMenu(parentFolder, hwnd, 1, &pidlLast, pos.x, pos.y, cm_ifs);
 
        parentFolder->Release();
    }
 
    return hr;
#else
    static DynamicFct<HRESULT(WINAPI*)(LPCITEMIDLIST, REFIID, LPVOID*, LPCITEMIDLIST*)> SHBindToParent(TEXT("SHELL32"), "SHBindToParent");
 
    if (SHBindToParent) {
        IShellFolder* parentFolder;
        LPCITEMIDLIST pidlLast;
 
         // get and use the parent folder to display correct context menu in all cases -> correct "Properties" dialog for directories, ...
        HRESULT hr = (*SHBindToParent)(pidl_abs, IID_IShellFolder, (LPVOID*)&parentFolder, &pidlLast);
 
        if (SUCCEEDED(hr)) {
            hr = ShellFolderContextMenu(parentFolder, hwnd, 1, &pidlLast, pos.x, pos.y, cm_ifs);
 
            parentFolder->Release();
        }
 
        return hr;
    } else {
        return ShellFolderContextMenu(GetDesktopFolder(), hwnd, 1, &pidl_abs, pos.x, pos.y, cm_ifs);
    }
#endif
}

extract_icon()

int Entry::extract_icon

(

ICONCACHE_FLAGS

flags = ICF_NORMAL

)

Definition at line 365 of file entries.cpp.

{
    TCHAR path[MAX_PATH];
 
    ICON_ID icon_id = ICID_NONE;
 
    if (_etype!=ET_SHELL && get_path(path, COUNTOF(path)))  // not for ET_SHELL to display the correct desktop icon
        if (!(flags & ICF_MIDDLE))  // not for ICF_MIDDLE to extract 24x24 icons because SHGetFileInfo() doesn't support this icon size
            icon_id = g_Globals._icon_cache.extract(path, flags);
 
    if (icon_id == ICID_NONE) {
        if (!(flags & ICF_OVERLAYS)) {
            IExtractIcon* pExtract;
            if (SUCCEEDED(GetUIObjectOf(0, IID_IExtractIcon, (LPVOID*)&pExtract))) {
                unsigned gil_flags = 0;
                int idx;
 
                if (flags & ICF_OPEN)
                    gil_flags |= GIL_OPENICON;
 
                if (SUCCEEDED(pExtract->GetIconLocation(GIL_FORSHELL, path, COUNTOF(path), &idx, &gil_flags))) {
                    if (gil_flags & GIL_NOTFILENAME)
                        icon_id = g_Globals._icon_cache.extract(pExtract, path, idx, flags);
                    else {
                        if (idx == -1)
                            idx = 0;    // special case for some control panel applications ("System")
 
                        icon_id = g_Globals._icon_cache.extract(path, idx, flags);
                    }
 
                /* using create_absolute_pidl() [see below] results in more correct icons for some control panel applets (NVidia display driver).
                    if (icon_id == ICID_NONE) {
                        SHFILEINFO sfi;
 
                        if (SHGetFileInfo(path, 0, &sfi, sizeof(sfi), SHGFI_ICON|SHGFI_SMALLICON))
                            icon_id = g_Globals._icon_cache.add(sfi.hIcon)._id;
                    } */
                /*
                    if (icon_id == ICID_NONE) {
                        LPBYTE b = (LPBYTE) alloca(0x10000);
                        SHFILEINFO sfi;
 
                        FILE* file = fopen(path, "rb");
                        if (file) {
                            int l = fread(b, 1, 0x10000, file);
                            fclose(file);
 
                            if (l)
                                icon_id = g_Globals._icon_cache.add(CreateIconFromResourceEx(b, l, TRUE, 0x00030000, 16, 16, LR_DEFAULTCOLOR));
                        }
                    } */
                }
            }
        }
 
        if (icon_id == ICID_NONE) {
            const ShellPath& pidl_abs = create_absolute_pidl();
            LPCITEMIDLIST pidl = pidl_abs;
 
            icon_id = g_Globals._icon_cache.extract(pidl, flags);
        }
    }
 
    return icon_id;
}

Referenced by safe_extract_icon().

find_entry()

virtual Entry * Entry::find_entry ( const void *  )

inlinevirtual

Reimplemented in FATDirectory, NtObjDirectory, RegDirectory, ShellDirectory, and WinDirectory.

Definition at line 124 of file entries.h.

{return NULL;}

free_subentries()

void Entry::free_subentries

(

)

Definition at line 743 of file entries.cpp.

{
    Entry *entry, *next=_down;
 
    if (next) {
        _down = 0;
 
        do {
            entry = next;
            next = entry->_next;
 
            entry->free_subentries();
            delete entry;
        } while(next);
    }
}

Referenced by smart_scan(), ~Entry(), Root::~Root(), and StartMenuDirectory::~StartMenuDirectory().

get_next_path_component()

virtual const void * Entry::get_next_path_component ( const void *  ) const

inlinevirtual

Reimplemented in FATDirectory, RegDirectory, ShellDirectory, and WinDirectory.

Definition at line 123 of file entries.h.

{return NULL;}

get_path()

virtual bool Entry::get_path ( PTSTR  path, size_t  path_count  ) const

pure virtual

Implemented in FATEntry, NtObjEntry, RegEntry, ShellEntry, ShellDirectory, and WinEntry.

Referenced by extract_icon(), GetUIObjectOf(), launch_entry(), and FileChildWindow::WndProc().

get_path_base()

bool Entry::get_path_base ( PTSTR  path, size_t  path_count, ENTRY_TYPE  etype  ) const

protected

Definition at line 639 of file entries.cpp.

{
    int level = 0;
    size_t len = 0;
    size_t l = 0;
    LPCTSTR name = NULL;
    TCHAR buffer[MAX_PATH];
 
    if (!path || path_count==0)
        return false;
 
    const Entry* entry;
    if ( path_count > 1 )
    {
        for(entry=this; entry; level++) {
            l = 0;
 
            if (entry->_etype == etype) {
                name = entry->_data.cFileName;
 
                for(LPCTSTR s=name; *s && *s!=TEXT('/') && *s!=TEXT('\\'); s++)
                    ++l;
 
                if (!entry->_up)
                    break;
            } else {
                if (entry->get_path(buffer, COUNTOF(buffer))) {
                    l = _tcslen(buffer);
                    name = buffer;
 
                    /* special handling of drive names */
                    if (l>0 && buffer[l-1]=='\\' && path[0]=='\\')
                        --l;
 
                    if ( len+l >= path_count )
                    {
                        if ( l + 1 > path_count )
                            len = 0;
                        else
                            len = path_count - l - 1;
                    }
                    memmove(path+l, path, len*sizeof(TCHAR));
                    if ( l+1 >= path_count )
                        l = path_count - 1;
                    memcpy(path, name, l*sizeof(TCHAR));
                    len += l;
                }
 
                entry = NULL;
                break;
            }
 
            if (l > 0) {
                if ( len+l+1 >= path_count )
                {
                    /* compare to 2 here because of terminator plus the '\\' we prepend */
                    if ( l + 2 > path_count )
                        len = 0;
                    else
                        len = path_count - l - 2;
                }
                memmove(path+l+1, path, len*sizeof(TCHAR));
                /* compare to 2 here because of terminator plus the '\\' we prepend */
                if ( l+2 >= path_count )
                    l = path_count - 2;
                memcpy(path+1, name, l*sizeof(TCHAR));
                len += l+1;
 
#ifndef _NO_WIN_FS
                if (etype == ET_WINDOWS && entry->_up && !(entry->_up->_data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY))  // a NTFS stream?
                    path[0] = TEXT(':');
                else
#endif
                    path[0] = TEXT('\\');
            }
 
            entry = entry->_up;
        }
 
        if (entry) {
            if ( len+l >= path_count )
            {
                if ( l + 1 > path_count )
                    len = 0;
                else
                    len = path_count - l - 1;
            }
            memmove(path+l, path, len*sizeof(TCHAR));
            if ( l+1 >= path_count )
                l = path_count - 1;
            memcpy(path, name, l*sizeof(TCHAR));
            len += l;
        }
 
        if ( !level && (len+1 < path_count) )
            path[len++] = TEXT('\\');
    }
 
    path[len] = TEXT('\0');
 
    return true;
}

Referenced by NtObjEntry::get_path(), RegEntry::get_path(), and WinEntry::get_path().

get_shell_folder()

ShellFolder Entry::get_shell_folder ( ) const

virtual

Reimplemented in ShellEntry, and ShellDirectory.

Definition at line 237 of file shellfs.cpp.

{
    return ShellFolder(create_absolute_pidl());
}

GetUIObjectOf()

HRESULT Entry::GetUIObjectOf ( HWND  hWnd, REFIID  riid, LPVOID *  ppvOut  )

virtual

Reimplemented in ShellEntry.

Definition at line 581 of file entries.cpp.

{
    TCHAR path[MAX_PATH];
/*
    if (!get_path(path, COUNTOF(path)))
        return E_FAIL;
 
    ShellPath shell_path(path);
 
    IShellFolder* pFolder;
    LPCITEMIDLIST pidl_last = NULL;
 
    static DynamicFct<HRESULT(WINAPI*)(LPCITEMIDLIST, REFIID, LPVOID*, LPCITEMIDLIST*)> SHBindToParent(TEXT("SHELL32"), "SHBindToParent");
 
    if (!SHBindToParent)
        return E_NOTIMPL;
 
    HRESULT hr = (*SHBindToParent)(shell_path, IID_IShellFolder, (LPVOID*)&pFolder, &pidl_last);
    if (FAILED(hr))
        return hr;
 
    ShellFolder shell_folder(pFolder);
 
    shell_folder->Release();
 
    return shell_folder->GetUIObjectOf(hWnd, 1, &pidl_last, riid, NULL, ppvOut);
*/
    if (!_up)
        return E_INVALIDARG;
 
    if (!_up->get_path(path, COUNTOF(path)))
        return E_FAIL;
 
    ShellPath shell_path(path);
    ShellFolder shell_folder(shell_path);
 
#ifdef UNICODE
    LPWSTR wname = _data.cFileName;
#else
    WCHAR wname[MAX_PATH];
    MultiByteToWideChar(CP_ACP, 0, _data.cFileName, -1, wname, COUNTOF(wname));
#endif
 
    LPITEMIDLIST pidl_last = NULL;
    HRESULT hr = shell_folder->ParseDisplayName(hWnd, NULL, wname, NULL, &pidl_last, NULL);
 
    if (FAILED(hr))
        return hr;
 
    hr = shell_folder->GetUIObjectOf(hWnd, 1, (LPCITEMIDLIST*)&pidl_last, riid, NULL, ppvOut);
 
    ShellMalloc()->Free((void*)pidl_last);
 
    return hr;
}

Referenced by extract_icon().

launch_entry()

BOOL Entry::launch_entry ( HWND  hwnd, UINT  nCmdShow = SW_SHOWNORMAL  )

virtual

Reimplemented in NtObjEntry, RegEntry, and ShellEntry.

Definition at line 443 of file entries.cpp.

{
    TCHAR cmd[MAX_PATH];
 
    if (!get_path(cmd, COUNTOF(cmd)))
        return FALSE;
 
     // add path to the recent file list
    SHAddToRecentDocs(SHARD_PATH, cmd);
 
      // start program, open document...
    return launch_file(hwnd, cmd, nCmdShow);
}

Referenced by QuickLaunchBar::Command().

read_directory()

virtual void Entry::read_directory ( int  scan_flags = 0 )

inlinevirtual

Reimplemented in FATDirectory, NtObjDirectory, RegDirectory, RegistryRoot, ShellDirectory, and WinDirectory.

Definition at line 122 of file entries.h.

{}

Referenced by read_directory_base().

read_directory_base()

void Entry::read_directory_base	(	SORT_ORDER	sortOrder = SORT_NAME,
		int	scan_flags = 0
	)

Todo:

_prescan_nodes should not be used for reading the start menu.

Definition at line 143 of file entries.cpp.

{
    CONTEXT("Entry::read_directory_base()");
 
     // call into subclass
    read_directory(scan_flags);
 
#ifndef ROSSHELL
    if (g_Globals._prescan_nodes) { 
        for(Entry*entry=_down; entry; entry=entry->_next)
            if (entry->_data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
                entry->read_directory(scan_flags);
                entry->sort_directory(sortOrder);
            }
    }
#endif
 
    sort_directory(sortOrder);
}

Referenced by smart_scan().

read_tree()

Entry * Entry::read_tree	(	const void *	path,
		SORT_ORDER	sortOrder = SORT_NAME,
		int	scan_flags = 0
	)

Definition at line 119 of file entries.cpp.

{
    CONTEXT("Entry::read_tree()");
 
    WaitCursor wait;
 
    Entry* entry = this;
 
    for(const void*p=path; p && entry; ) {
        entry->smart_scan(sortOrder, scan_flags);
 
        if (entry->_down)
            entry->_expanded = true;
 
        Entry* found = entry->find_entry(p);
        p = entry->get_next_path_component(p);
 
        entry = found;
    }
 
    return entry;
}

Referenced by Root::read_tree().

safe_extract_icon()

int Entry::safe_extract_icon

(

ICONCACHE_FLAGS

flags = ICF_NORMAL

)

Definition at line 431 of file entries.cpp.

{
    try {
        return extract_icon(flags);
    } catch(COMException&) {
        // ignore unexpected exceptions while extracting icons
    }
 
    return ICID_NONE;
}

smart_scan()

void Entry::smart_scan	(	SORT_ORDER	sortOrder = SORT_NAME,
		int	scan_flags = 0
	)

Todo:

We could use IShellFolder2::GetDefaultColumn to determine sort order.

Definition at line 353 of file entries.cpp.

{
    CONTEXT("Entry::smart_scan()");
 
    if (!_scanned) {
        free_subentries();
        read_directory_base(sortOrder, scan_flags); 
    }
}

Referenced by QuickLaunchBar::AddShortcuts(), ShellBrowser::jump_to(), and Root::read_tree().

sort_directory()

void Entry::sort_directory

(

SORT_ORDER

sortOrder

)

Definition at line 321 of file entries.cpp.

{
    if (sortOrder != SORT_NONE) {
        Entry* entry = _down;
        Entry** array, **p;
        int len;
 
        len = 0;
        for(entry=_down; entry; entry=entry->_next)
            ++len;
 
        if (len) {
            array = (Entry**) alloca(len*sizeof(Entry*));
 
            p = array;
            for(entry=_down; entry; entry=entry->_next)
                *p++ = entry;
 
             // call qsort with the appropriate compare function
            qsort(array, len, sizeof(array[0]), sortFunctions[sortOrder]);
 
            _down = array[0];
 
            for(p=array; --len; p++)
                (*p)->_next = p[1];
 
            (*p)->_next = 0;
        }
    }
}

Referenced by read_directory_base().

Member Data Documentation

_bhfi

BY_HANDLE_FILE_INFORMATION Entry::_bhfi

Definition at line 110 of file entries.h.

Referenced by Entry().

_bhfi_valid

bool Entry::_bhfi_valid

Definition at line 111 of file entries.h.

Referenced by Entry().

_content

LPTSTR Entry::_content

Definition at line 105 of file entries.h.

Referenced by Entry(), and ~Entry().

_data

WIN32_FIND_DATA Entry::_data

Definition at line 100 of file entries.h.

Referenced by compareDate(), compareExt(), compareName(), compareSize(), compareType(), Entry(), GetUIObjectOf(), RegistryRoot::read_directory(), RegDirectory::RegDirectory(), ShellDirectory::ShellDirectory(), and ~Entry().

_display_name

LPTSTR Entry::_display_name

Definition at line 103 of file entries.h.

Referenced by Entry(), and ~Entry().

_down

Entry* Entry::_down

Definition at line 93 of file entries.h.

Referenced by QuickLaunchBar::AddShortcuts(), Entry(), ShellDirectory::extract_icons(), NtObjDirectory::find_entry(), RegDirectory::find_entry(), ShellDirectory::find_entry(), WinDirectory::find_entry(), free_subentries(), NtObjDirectory::read_directory(), RegDirectory::read_directory(), RegistryRoot::read_directory(), ShellDirectory::read_directory(), WinDirectory::read_directory(), read_directory_base(), Root::read_tree(), sort_directory(), and ~Entry().

_etype

ENTRY_TYPE Entry::_etype

Definition at line 107 of file entries.h.

Referenced by ShellEntry::create_absolute_pidl(), Entry(), and extract_icon().

_expanded

bool Entry::_expanded

Definition at line 96 of file entries.h.

Referenced by Entry(), Root::read_tree(), and FileChildWindow::refresh().

_icon_id

int Entry::_icon_id

Definition at line 108 of file entries.h.

Referenced by Entry(), and ~Entry().

_level

int Entry::_level

Definition at line 98 of file entries.h.

Referenced by FileChildWindow::collapse_entry(), Entry(), NtObjDirectory::read_directory(), RegDirectory::read_directory(), RegistryRoot::read_directory(), ShellDirectory::read_directory(), WinDirectory::read_directory(), and FileChildWindow::scan_entry().

_next

Entry* Entry::_next

Definition at line 92 of file entries.h.

Referenced by Entry().

_scanned

bool Entry::_scanned

Definition at line 97 of file entries.h.

Referenced by Entry(), NtObjDirectory::read_directory(), RegDirectory::read_directory(), RegistryRoot::read_directory(), ShellDirectory::read_directory(), WinDirectory::read_directory(), and smart_scan().

_shell_attribs

SFGAOF Entry::_shell_attribs

Definition at line 102 of file entries.h.

Referenced by compareType(), Entry(), and ShellDirectory::ShellDirectory().

_type_name

LPTSTR Entry::_type_name

Definition at line 104 of file entries.h.

Referenced by Entry(), and ~Entry().

_up

Entry* Entry::_up

Definition at line 94 of file entries.h.

Referenced by FileChildWindow::activate_entry(), ShellEntry::create_absolute_pidl(), ShellEntry::do_context_menu(), Entry(), ShellEntry::get_parent_folder(), and GetUIObjectOf().

---

The documentation for this struct was generated from the following files:

• modules/rosapps/applications/explorer-old/shell/entries.h
• modules/rosapps/applications/explorer-old/shell/entries.cpp
• modules/rosapps/applications/explorer-old/shell/shellfs.cpp