FileHandle.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_DEVICES_MULTIAXIS_WIN32_FILEHANDLE_H
#define SURGSIM_DEVICES_MULTIAXIS_WIN32_FILEHANDLE_H

#include <stdint.h>
#include <string>


namespace SurgSim
{
namespace Devices
{

class FileHandle
{
public:
    typedef void* RawHandleType;

    FileHandle();

    FileHandle(FileHandle&& other);

    FileHandle& operator=(FileHandle&& other);

    ~FileHandle();

    bool isValid() const;

    bool canRead() const;

    bool canWrite() const;

    bool hasDataToRead() const;

    bool readBytes(void* dataBuffer, unsigned int bytesToRead, unsigned int* bytesActuallyRead);

    RawHandleType get() const;

    bool openForReadingAndWriting(const std::string& path);

    bool openForReading(const std::string& path);

    bool openForWriting(const std::string& path);

    bool openForReadingAndMaybeWriting(const std::string& path);

    void setFileOpenFlags(uint64_t flags);

    uint64_t getFileOpenFlags() const;

    void reset();

private:
    // Prevent copy construction and copy assignment.  (VS2012 does not support "= delete" yet.)
    FileHandle(const FileHandle& other) /*= delete*/;
    FileHandle& operator=(const FileHandle& other) /*= delete*/;

    RawHandleType m_handle;
    bool m_canRead;
    bool m_canWrite;
    uint64_t m_openFlags;
};

};  // namespace Devices
};  // namespace SurgSim

#endif  // SURGSIM_DEVICES_MULTIAXIS_WIN32_FILEHANDLE_H