mirror of
https://github.com/wesnoth/wesnoth
synced 2025-04-30 01:47:13 +00:00
2101353d36
Turns out I mistook @celticminstrel's opinion that we should use include guards over pragma (737916e). Since all major compilers support `#pragma once`, there's no reason not to use it. For future mergability reasons, this excludes src/spirit_po and src/xBRZ. It also excludes src/boost-patched.
53 lines
1.9 KiB
C++
53 lines
1.9 KiB
C++
/*
|
|
Copyright (C) 2017 by the Battle for Wesnoth Project http://www.wesnoth.org/
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY.
|
|
|
|
See the COPYING file for more details.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "config.hpp"
|
|
#include <list>
|
|
#include "utils/functional.hpp"
|
|
/*
|
|
The purpose if this class is to preprocess incoming network data, and provide a steam that always returns just one command/action at a time.
|
|
Especially we want each replay command in his own [turn].
|
|
*/
|
|
class playturn_network_adapter
|
|
{
|
|
public:
|
|
typedef std::function<bool(config&)> source_type;
|
|
|
|
playturn_network_adapter(source_type source);
|
|
~playturn_network_adapter();
|
|
|
|
//returns true on success.
|
|
//dst has to be empty before the call.
|
|
//after the call dst contains one child when returned true otherwise it's empty.
|
|
bool read(config& dst);
|
|
//returns false if there is still data in the internal buffer.
|
|
bool is_at_end();
|
|
void set_source(source_type source);
|
|
//returns a function to be passed to set_source.
|
|
static source_type get_source_from_config(config& src);
|
|
private:
|
|
//reads data from the network stream.
|
|
void read_from_network();
|
|
//this always contains one empty config because we want a valid value for next_.
|
|
std::list<config> data_;
|
|
//the position of the next to be received element in data_->front().
|
|
config::all_children_iterator next_;
|
|
//if we are processing a [turn] with multiple [command] we want to split them.
|
|
//In this case next_command_num_ is the next to be processed turn into a command otherwise it's 0;
|
|
unsigned int next_command_num_;
|
|
//a function to receive data from the network.
|
|
source_type network_reader_;
|
|
};
|