1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
|
/*
* Copyright © Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 or 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MIR_TEST_FRAMEWORK_OPEN_WRAPPER_H_
#define MIR_TEST_FRAMEWORK_OPEN_WRAPPER_H_
#include <functional>
#include <memory>
#include <optional>
#include <sys/stat.h>
namespace mir_test_framework
{
using OpenHandlerHandle = std::unique_ptr<void, void(*)(void*)>;
using OpenHandler =
std::function<std::optional<int>(char const* path, int flags, std::optional<mode_t> mode)>;
/**
* Add a function to the open() interposer.
*
* When code calls ::open() the test framework first checks against all of the registered
* handlers, returning the value from the first handler to return an occupied optional<int>
*
* \note The new handler is added to the \em start of the handler chain; it will be called
* before any existing handler on open().
*
* \param handler [in] Handler to call when open() is called. The handler should return an
* occupied optional<int> only when it wants to claim this invocation.
* ::open() is a variadic C function; to simplify implementations of
* OpenHandlers, the handler is passed an optional<mode_t> instead.
* \return An opaque handle to this instance of the handler. Dropping the handle unregisters the
* open() handler.
*/
OpenHandlerHandle add_open_handler(OpenHandler handler);
}
#endif //MIR_TEST_FRAMEWORK_OPEN_WRAPPER_H_
|