UTDirectory.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_DIRECTORY_H_
#define _UT_DIRECTORY_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTPath.h"
#include "UTLists.h"


//==================================================================================================
class UT_EXPORT Directory_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline          Directory_t();

    inline          ~Directory_t();

    Status_t        Open(const Path_t& path);

    Status_t        NextChild(out Path_t* child);

    Status_t        Close();

    static Status_t GetFileList(    const Path_t& path,
                                    out gives OwnedList_t<Path_t>* file_list,
                                    const utf8* only_files_starting_with = NULL );

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    dir_t       m_dir;
    #if WINDOWS
        Path_t  m_first;
    #endif
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline
Directory_t::Directory_t()
{
    m_dir = NULL;
}


inline
Directory_t::~Directory_t()
{
    if(m_dir)
        Close();
    assert(!m_dir);
}


#endif // _UT_DIRECTORY_H_