OW_File.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, 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 Vintela, Inc. nor the names of its
*    contributors 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 Vintela, Inc. OR THE 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 OW_FILE_HPP_INCLUDE_GUARD_
#define OW_FILE_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_Types.hpp"
#include "OW_FileSystem.hpp"
#include <algorithm> // for std::swap

namespace OW_NAMESPACE
{

class OW_COMMON_API File
{
public:
   File() : m_hdl(OW_INVALID_FILEHANDLE)
   {
   }
   File(const File& x);
   ~File()
   {
      close();
   }
   File& operator= (const File& x)
   {
      File(x).swap(*this);
      return *this;
   }
   void swap(File& x)
   {
      std::swap(m_hdl, x.m_hdl);
   }
   size_t read(void* bfr, size_t numberOfBytes, off_t offset=-1L) const
   {
      return FileSystem::read(m_hdl, bfr, numberOfBytes, offset);
   }
   size_t write(const void* bfr, size_t numberOfBytes, off_t offset=-1L)
   {
      return FileSystem::write(m_hdl, bfr, numberOfBytes, offset);
   }
   int seek(off_t offset, int whence) const
   {
      return FileSystem::seek(m_hdl, offset, whence);
   }
   off_t tell() const
   {
      return FileSystem::tell(m_hdl);
   }
   void rewind() const
   {
      FileSystem::rewind(m_hdl);
   }
   int close()
   {
      if (m_hdl != OW_INVALID_FILEHANDLE)
      {
         int rv = FileSystem::close(m_hdl);
         m_hdl = OW_INVALID_FILEHANDLE;
         return rv;
      }
      return 0;
   }
   int flush()
   {
      return FileSystem::flush(m_hdl);
   }
   int getLock();
   int tryLock();
   int unlock();

   typedef FileHandle File::*safe_bool;
   operator safe_bool () const
      {  return (m_hdl != OW_INVALID_FILEHANDLE) ? &File::m_hdl : 0; }
   bool operator!() const
      {  return m_hdl == OW_INVALID_FILEHANDLE; }
   bool operator==(const File& rhs)
   {
      return m_hdl == rhs.m_hdl;
   }

   File(FileHandle hdl) : m_hdl(hdl)
   {
   }

private:

   FileHandle  m_hdl;
};

} // end namespace OW_NAMESPACE

#endif

---