FileSystem.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Quest Software, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Quest Software, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_FILESYSTEM_HPP_INCLUDE_GUARD_
#define BLOCXX_FILESYSTEM_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/Types.hpp"
#include "blocxx/ArrayFwd.hpp"
#include "blocxx/Exception.hpp"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/String.hpp"
#ifdef BLOCXX_ENABLE_TEST_HOOKS
#include "blocxx/GlobalPtr.hpp"
#endif

#include <utility>

#ifdef BLOCXX_HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif
#ifndef MAXPATHLEN
#ifdef PATH_MAX
#define MAXPATHLEN PATH_MAX
#else
#define MAXPATHLEN 1024
#endif
#endif

namespace BLOCXX_NAMESPACE
{

BLOCXX_DECLARE_APIEXCEPTION(FileSystem, BLOCXX_COMMON_API)


namespace FileSystem
{
   BLOCXX_COMMON_API File openFile(const String& path);
   BLOCXX_COMMON_API File createFile(const String& path);
   BLOCXX_COMMON_API File openOrCreateFile(const String& path);
   BLOCXX_COMMON_API File openForAppendOrCreateFile(const String& path);
   BLOCXX_COMMON_API File createAutoDeleteTempFile(const String& dir=String());
   BLOCXX_COMMON_API File createTempFile(String& filePath,
      const String& dir=String());
   BLOCXX_COMMON_API int changeFileOwner(const String& filename,
      const UserId& userId);
   BLOCXX_COMMON_API bool exists(const String& path);
#ifndef BLOCXX_WIN32

   BLOCXX_COMMON_API bool isExecutable(const String& path);
#endif

   BLOCXX_COMMON_API bool canRead(const String& path);
   BLOCXX_COMMON_API bool canWrite(const String& path);
#ifndef BLOCXX_WIN32

   BLOCXX_COMMON_API bool isLink(const String& path);
#endif

   BLOCXX_COMMON_API bool isDirectory(const String& path);
   BLOCXX_COMMON_API bool changeDirectory(const String& path);
#ifndef BLOCXX_WIN32
   BLOCXX_COMMON_API bool makeDirectory(const String& path, int mode=0777);
#else
   BLOCXX_COMMON_API bool makeDirectory(const String& path, int mode=-1);
#endif

   BLOCXX_COMMON_API bool getFileSize(const String& path, Int64& size);
   BLOCXX_COMMON_API UInt64 fileSize(FileHandle fh);
   BLOCXX_COMMON_API bool removeDirectory(const String& path);
   BLOCXX_COMMON_API bool removeFile(const String& path);
   BLOCXX_COMMON_API bool getDirectoryContents(const String& path,
      StringArray& dirEntries);
   BLOCXX_COMMON_API bool renameFile(const String& oldFileName,
      const String& newFileName);
   BLOCXX_COMMON_API size_t read(const FileHandle& hdl, void* bfr, size_t numberOfBytes,
      Int64 offset=-1L);
   BLOCXX_COMMON_API size_t write(FileHandle hdl, const void* bfr,
      size_t numberOfBytes, Int64 offset=-1L);
   BLOCXX_COMMON_API Int64 seek(const FileHandle& hdl, Int64 offset, int whence);
   BLOCXX_COMMON_API Int64 tell(const FileHandle& hdl);
   BLOCXX_COMMON_API void rewind(const FileHandle& hdl);
   BLOCXX_COMMON_API int close(const FileHandle& hdl);
   BLOCXX_COMMON_API int flush(FileHandle& hdl);
   BLOCXX_COMMON_API String getFileContents(const String& filename);
   
   BLOCXX_COMMON_API StringArray getFileLines(const String& filename);

   BLOCXX_COMMON_API String readSymbolicLink(const String& path);

   namespace Path
   {
      BLOCXX_COMMON_API String realPath(const String& path);

      enum ESecurity
      {
         E_INSECURE, E_SECURE_DIR, E_SECURE_FILE
      };

      BLOCXX_COMMON_API std::pair<ESecurity, String>
         security(String const & path, UserId uid);

      BLOCXX_COMMON_API std::pair<ESecurity, String> security(String const & path);

      BLOCXX_COMMON_API std::pair<ESecurity, String>
         security(String const & base_dir, String const & rel_path, UserId uid);

      BLOCXX_COMMON_API std::pair<ESecurity, String>
         security(String const & base_dir, String const & rel_path);

      BLOCXX_COMMON_API String dirname(const String& filename);

      BLOCXX_COMMON_API String basename(const String& filename);

      BLOCXX_COMMON_API String getCurrentWorkingDirectory();


   } // end namespace Path

   struct NullFactory
   {
      static void* create()
      {
         return 0;
      }
   };
#ifdef BLOCXX_ENABLE_TEST_HOOKS
   typedef GlobalPtr<FileSystemMockObject, NullFactory> FileSystemMockObject_t;
   extern FileSystemMockObject_t g_fileSystemMockObject;
#endif

} // end namespace FileSystem

} // end namespace BLOCXX_NAMESPACE

#endif