dvander@372: /**
dvander@375:  * vim: set ts=4 :
dvander@372:  * ===============================================================
dvander@376:  * SourceMod, Copyright (C) 2004-2007 AlliedModders LLC. 
dvander@376:  * All rights reserved.
dvander@372:  * ===============================================================
dvander@372:  *
dvander@379:  *  This file is part of the SourceMod/SourcePawn SDK.  This file may only be 
dvander@379:  * used or modified under the Terms and Conditions of its License Agreement, 
dvander@379:  * which is found in public/licenses/LICENSE.txt.  As of this notice, derivative 
dvander@379:  * works must be licensed under the GNU General Public License (version 2 or 
dvander@379:  * greater).  A copy of the GPL is included under public/licenses/GPL.txt.
dvander@379:  * 
dvander@379:  * To view the latest information, see: http://www.sourcemod.net/license.php
dvander@372:  *
dvander@372:  * Version: $Id$
dvander@372:  */
dvander@372: 
dvander@324: #ifndef _INCLUDE_SOURCEMOD_LIBRARY_INTERFACE_SYS_H_
dvander@324: #define _INCLUDE_SOURCEMOD_LIBRARY_INTERFACE_SYS_H_
dvander@324: 
dvander@372: /**
dvander@372:  * @file ILibrarySys.h
dvander@372:  * @brief Defines platform-dependent operations, such as opening libraries and files.
dvander@372:  */
dvander@372: 
dvander@324: #include <IShareSys.h>
dvander@324: 
dvander@324: namespace SourceMod
dvander@324: {
dvander@324: 	#define SMINTERFACE_LIBRARYSYS_NAME		"ILibrarySys"
ds@794: 	#define SMINTERFACE_LIBRARYSYS_VERSION	2
dvander@324: 
dvander@324: 	class ILibrary
dvander@324: 	{
dvander@324: 	public:
dvander@372: 		/** Virtual destructor (calls CloseLibrary) */
dvander@324: 		virtual ~ILibrary()
dvander@324: 		{
dvander@324: 		};
dvander@324: 	public:
dvander@324: 		/**
dvander@324: 		 * @brief Closes dynamic library and invalidates pointer.
dvander@324: 		 */
dvander@324: 		virtual void CloseLibrary() =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Retrieves a symbol pointer from the dynamic library.
dvander@324: 		 *
dvander@324: 		 * @param symname	Symbol name.
dvander@324: 		 * @return			Symbol pointer, NULL if not found.
dvander@324: 		 */
dvander@324: 		virtual void *GetSymbolAddress(const char *symname) =0;
dvander@324: 	};
dvander@324: 
dvander@324: 	/**
dvander@324: 	 * @brief Directory browsing abstraction.
dvander@324: 	 */
dvander@324: 	class IDirectory
dvander@324: 	{
dvander@324: 	public:
dvander@372: 		/** Virtual destructor */
dvander@324: 		virtual ~IDirectory()
dvander@324: 		{
dvander@324: 		}
dvander@324: 	public:
dvander@324: 		/**
dvander@324: 		 * @brief Returns true if there are more files to read, false otherwise.
dvander@324: 		 */
dvander@324: 		virtual bool MoreFiles() =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Advances to the next entry in the stream.
dvander@324: 		 */
dvander@324: 		virtual void NextEntry() =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Returns the name of the current entry.
dvander@324: 		 */
dvander@324: 		virtual const char *GetEntryName() =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Returns whether the current entry is a directory.
dvander@324: 		 */
dvander@324: 		virtual bool IsEntryDirectory() =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Returns whether the current entry is a file.
dvander@324: 		 */
dvander@324: 		virtual bool IsEntryFile() =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Returns true if the current entry is valid
dvander@324: 		 *        (Used similarly to MoreFiles).
dvander@324: 		 */
dvander@324: 		virtual bool IsEntryValid() =0;
dvander@324: 	};
dvander@324: 
dvander@324: 	/**
dvander@324: 	 * @brief Contains various operating system specific code.
dvander@324: 	 */
dvander@324: 	class ILibrarySys : public SMInterface
dvander@324: 	{
dvander@324: 	public:
dvander@324: 		virtual const char *GetInterfaceName()
dvander@324: 		{
dvander@324: 			return SMINTERFACE_LIBRARYSYS_NAME;
dvander@324: 		}
dvander@324: 		virtual unsigned int GetInterfaceVersion()
dvander@324: 		{
dvander@324: 			return SMINTERFACE_LIBRARYSYS_VERSION;
dvander@324: 		}
dvander@324: 	public:
dvander@324: 		/**
dvander@324: 		 * @brief Opens a dynamic library file.
dvander@324: 		 * 
dvander@324: 		 * @param path		Path to library file (.dll/.so).
dvander@324: 		 * @param error		Buffer for any error message (may be NULL).
ds@755: 		 * @param maxlength	Maximum length of error buffer.
dvander@324: 		 * @return			Pointer to an ILibrary, NULL if failed.
dvander@324: 		 */
ds@755: 		virtual ILibrary *OpenLibrary(const char *path, char *error, size_t maxlength) =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Opens a directory for reading.
dvander@324: 		 *
dvander@324: 		 * @param path		Path to directory.
dvander@324: 		 * @return			Pointer to an IDirectory, NULL if failed.
dvander@324: 		 */
dvander@324: 		virtual IDirectory *OpenDirectory(const char *path) =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Closes a directory and frees its handle.
dvander@324: 		 * 
dvander@324: 		 * @param dir		Pointer to IDirectory.
dvander@324: 		 */
dvander@324: 		virtual void CloseDirectory(IDirectory *dir) =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Returns true if a path exists.
dvander@324: 		 */
dvander@324: 		virtual bool PathExists(const char *path) =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Returns true if the path is a normal file.
dvander@324: 		 */
dvander@324: 		virtual bool IsPathFile(const char *path) =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Returns true if the path is a normal directory.
dvander@324: 		 */
dvander@324: 		virtual bool IsPathDirectory(const char *path) =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Gets a platform-specific error message.
dvander@324: 		 * This should only be called when an ILibrary function fails.
dvander@324: 		 * Win32 equivalent: GetLastError() + FormatMessage()
dvander@324: 		 * POSIX equivalent: errno + strerror()
dvander@324: 		 *
dvander@324: 		 * @param error		Error message buffer.
ds@755: 		 * @param maxlength	Maximum length of error buffer.
dvander@324: 		 */
ds@755: 		virtual void GetPlatformError(char *error, size_t maxlength) =0;
dvander@324: 
dvander@324: 		/**
dvander@324: 		 * @brief Formats a string similar to snprintf(), except
dvander@324: 		 * corrects all non-platform compatible path separators to be
dvander@324: 		 * the correct platform character.
dvander@324: 		 *
dvander@324: 		 * @param buffer	Output buffer pointer.
dvander@324: 		 * @param maxlength	Output buffer size.
dvander@324: 		 * @param pathfmt	Format string of path.
dvander@324: 		 * @param ...		Format string arguments.
dvander@324: 		 */
dvander@324: 		virtual size_t PathFormat(char *buffer, size_t maxlength, const char *pathfmt, ...) =0;
ds@794: 
ds@794: 		/**
ds@794: 		 * @brief Returns a pointer to the extension in a filename.
ds@794: 		 *
ds@794: 		 * @param filename	Name of file from which the extension should be extracted.
ds@794: 		 * @return			Pointer to file extension.
ds@794: 		 */
ds@794: 		virtual const char *GetFileExtension(const char *filename) =0;
dvander@324: 	};
ds@432: }
dvander@324: 
dvander@324: #endif //_INCLUDE_SOURCEMOD_LIBRARY_INTERFACE_SYS_H_