virtual_file_source.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 **    Harry Storbacka
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_core.h"
00036 #include "../System/sharedptr.h"
00037 #include "file.h"
00038 
00039 class CL_IODevice;
00040 class CL_VirtualDirectoryListingEntry;
00041 
00045 class CL_API_CORE CL_VirtualFileSource
00046 {
00049 
00050 public:
00051         virtual ~CL_VirtualFileSource() { return; }
00052 
00056 
00057 public:
00058 
00062 
00063 public:
00065 
00071         virtual CL_IODevice open_file(const CL_String &filename,
00072                 CL_File::OpenMode mode = CL_File::open_existing,
00073                 unsigned int access = CL_File::access_read | CL_File::access_write,
00074                 unsigned int share = CL_File::share_all,
00075                 unsigned int flags = 0) = 0;
00076 
00078         virtual bool initialize_directory_listing(const CL_String &path) = 0;
00079 
00081         virtual bool next_file(CL_VirtualDirectoryListingEntry &entry) = 0;
00082 
00084         virtual CL_String get_path() const = 0;
00085 
00090         virtual CL_String get_identifier() const = 0;
00091 
00095 
00096 private:
00098 };
00099