libcruft-util/io_posix.hpp

87 lines
2.6 KiB
C++
Raw Normal View History

/*
2015-04-13 18:05:28 +10:00
* 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
*
2015-04-13 18:05:28 +10:00
* http://www.apache.org/licenses/LICENSE-2.0
*
2015-04-13 18:05:28 +10:00
* 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.
*
2016-06-28 14:14:23 +10:00
* Copyright 2010-2016 Danny Robson <danny@nerdcruft.net>
*/
#ifndef __UTIL_IO_POSIX_HPP
#define __UTIL_IO_POSIX_HPP
#include "posix/fd.hpp"
2016-06-28 14:15:19 +10:00
#include "view.hpp"
#include <type_traits>
#include <experimental/filesystem>
2015-10-29 10:48:11 +11:00
#include <sys/mman.h>
#include <fcntl.h>
namespace util {
2017-01-05 15:06:49 +11:00
namespace detail::posix {
class mapped_file {
2016-06-28 12:21:12 +10:00
public:
using value_type = uint8_t;
using reference = value_type&;
using const_reference = const value_type&;
using iterator = value_type*;
using const_iterator = const value_type*;
using difference_type = std::iterator_traits<iterator>::difference_type;
using size_type = size_t;
mapped_file (const std::experimental::filesystem::path&,
int fflags = O_RDONLY | O_BINARY,
int mflags = PROT_READ);
mapped_file (const util::posix::fd&,
int mflags = PROT_READ);
2016-06-28 12:21:12 +10:00
mapped_file (const mapped_file&) = delete;
mapped_file& operator= (const mapped_file&) = delete;
2016-06-28 12:21:12 +10:00
~mapped_file ();
2016-06-28 12:21:12 +10:00
bool empty (void) const;
/// returns the total allocated mapped region in bytes.
///
/// result is typed size_t (rather than a signed type) because we
/// often use this in conjunction with sizeof and packed structure.
/// it is greatly simpler to cast to signed where it's actually
/// required rather than the other way around.
size_type size (void) const;
2016-06-28 14:14:23 +10:00
const_iterator data (void) const &;
iterator data (void) &;
iterator begin (void) &;
iterator end (void) &;
2016-06-28 12:21:30 +10:00
const_iterator begin (void) const &;
const_iterator end (void) const &;
const_iterator cbegin (void) const &;
const_iterator cend (void) const &;
2016-06-28 14:15:19 +10:00
2016-06-28 12:21:30 +10:00
private:
uint8_t *m_data;
size_t m_size;
};
2017-01-05 15:06:49 +11:00
}
typedef detail::posix::mapped_file mapped_file;
}
2016-06-28 14:15:19 +10:00
#include "io_posix.ipp"
#endif