/*
Minetest-c55
Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>

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; 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, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include "connection.h"
#include "main.h"
#include "serialization.h"

namespace con
{

BufferedPacket makePacket(Address &address, u8 *data, u32 datasize,
		u32 protocol_id, u16 sender_peer_id, u8 channel)
{
	u32 packet_size = datasize + BASE_HEADER_SIZE;
	BufferedPacket p(packet_size);
	p.address = address;

	writeU32(&p.data[0], protocol_id);
	writeU16(&p.data[4], sender_peer_id);
	writeU8(&p.data[6], channel);

	memcpy(&p.data[BASE_HEADER_SIZE], data, datasize);

	return p;
}

BufferedPacket makePacket(Address &address, SharedBuffer<u8> &data,
		u32 protocol_id, u16 sender_peer_id, u8 channel)
{
	return makePacket(address, *data, data.getSize(),
			protocol_id, sender_peer_id, channel);
}

SharedBuffer<u8> makeOriginalPacket(
		SharedBuffer<u8> data)
{
	u32 header_size = 1;
	u32 packet_size = data.getSize() + header_size;
	SharedBuffer<u8> b(packet_size);

	writeU8(&b[0], TYPE_ORIGINAL);

	memcpy(&b[header_size], *data, data.getSize());

	return b;
}

core::list<SharedBuffer<u8> > makeSplitPacket(
		SharedBuffer<u8> data,
		u32 chunksize_max,
		u16 seqnum)
{
	// Chunk packets, containing the TYPE_SPLIT header
	core::list<SharedBuffer<u8> > chunks;
	
	u32 chunk_header_size = 7;
	u32 maximum_data_size = chunksize_max - chunk_header_size;
	u32 start = 0;
	u32 end = 0;
	u32 chunk_num = 0;
	do{
		end = start + maximum_data_size - 1;
		if(end > data.getSize() - 1)
			end = data.getSize() - 1;
		
		u32 payload_size = end - start + 1;
		u32 packet_size = chunk_header_size + payload_size;

		SharedBuffer<u8> chunk(packet_size);
		
		writeU8(&chunk[0], TYPE_SPLIT);
		writeU16(&chunk[1], seqnum);
		// [3] u16 chunk_count is written at next stage
		writeU16(&chunk[5], chunk_num);
		memcpy(&chunk[chunk_header_size], &data[start], payload_size);

		chunks.push_back(chunk);
		
		start = end + 1;
		chunk_num++;
	}
	while(end != data.getSize() - 1);

	u16 chunk_count = chunks.getSize();

	core::list<SharedBuffer<u8> >::Iterator i = chunks.begin();
	for(; i != chunks.end(); i++)
	{
		// Write chunk_count
		writeU16(&((*i)[3]), chunk_count);
	}

	return chunks;
}

core::list<SharedBuffer<u8> > makeAutoSplitPacket(
		SharedBuffer<u8> data,
		u32 chunksize_max,
		u16 &split_seqnum)
{
	u32 original_header_size = 1;
	core::list<SharedBuffer<u8> > list;
	if(data.getSize() + original_header_size > chunksize_max)
	{
		list = makeSplitPacket(data, chunksize_max, split_seqnum);
		split_seqnum++;
		return list;
	}
	else
	{
		list.push_back(makeOriginalPacket(data));
	}
	return list;
}

SharedBuffer<u8> makeReliablePacket(
		SharedBuffer<u8> data,
		u16 seqnum)
{
	/*dstream<<"BEGIN SharedBuffer<u8> makeReliablePacket()"<<std::endl;
	dstream<<"data.getSize()="<<data.getSize()<<", data[0]="
			<<((unsigned int)data[0]&0xff)<<std::endl;*/
	u32 header_size = 3;
	u32 packet_size = data.getSize() + header_size;
	SharedBuffer<u8> b(packet_size);

	writeU8(&b[0], TYPE_RELIABLE);
	writeU16(&b[1], seqnum);

	memcpy(&b[header_size], *data, data.getSize());

	/*dstream<<"data.getSize()="<<data.getSize()<<", data[0]="
			<<((unsigned int)data[0]&0xff)<<std::endl;*/
	//dstream<<"END SharedBuffer<u8> makeReliablePacket()"<<std::endl;
	return b;
}

/*
	ReliablePacketBuffer
*/

void ReliablePacketBuffer::print()
{
	core::list<BufferedPacket>::Iterator i;
	i = m_list.begin();
	for(; i != m_list.end(); i++)
	{
		u16 s = readU16(&(i->data[BASE_HEADER_SIZE+1]));
		dout_con<<s<<" ";
	}
}
bool ReliablePacketBuffer::empty()
{
	return m_list.empty();
}
u32 ReliablePacketBuffer::size()
{
	return m_list.getSize();
}
RPBSearchResult ReliablePacketBuffer::findPacket(u16 seqnum)
{
	core::list<BufferedPacket>::Iterator i;
	i = m_list.begin();
	for(; i != m_list.end(); i++)
	{
		u16 s = readU16(&(i->data[BASE_HEADER_SIZE+1]));
		/*dout_con<<"findPacket(): finding seqnum="<<seqnum
				<<", comparing to s="<<s<<std::endl;*/
		if(s == seqnum)
			break;
	}
	return i;
}
RPBSearchResult ReliablePacketBuffer::notFound()
{
	return m_list.end();
}
u16 ReliablePacketBuffer::getFirstSeqnum()
{
	if(empty())
		throw NotFoundException("Buffer is empty");
	BufferedPacket p = *m_list.begin();
	return readU16(&p.data[BASE_HEADER_SIZE+1]);
}
BufferedPacket ReliablePacketBuffer::popFirst()
{
	if(empty())
		throw NotFoundException("Buffer is empty");
	BufferedPacket p = *m_list.begin();
	core::list<BufferedPacket>::Iterator i = m_list.begin();
	m_list.erase(i);
	return p;
}
BufferedPacket ReliablePacketBuffer::popSeqnum(u16 seqnum)
{
	RPBSearchResult r = findPacket(seqnum);
	if(r == notFound()){
		dout_con<<"Not found"<<std::endl;
		throw NotFoundException("seqnum not found in buffer");
	}
	BufferedPacket p = *r;
	m_list.erase(r);
	return p;
}
void ReliablePacketBuffer::insert(BufferedPacket &p)
{
	assert(p.data.getSize() >= BASE_HEADER_SIZE+3);
	u8 type = readU8(&p.data[BASE_HEADER_SIZE+0]);
	assert(type == TYPE_RELIABLE);
	u16 seqnum = readU16(&p.data[BASE_HEADER_SIZE+1]);

	// Find the right place for the packet and insert it there

	// If list is empty, just add it
	if(m_list.empty())
	{
		m_list.push_back(p);
		// Done.
		return;
	}
	// Otherwise find the right place
	core::list<BufferedPacket>::Iterator i;
	i = m_list.begin();
	// Find the first packet in the list which has a higher seqnum
	for(; i != m_list.end(); i++){
		u16 s = readU16(&(i->data[BASE_HEADER_SIZE+1]));
		if(s == seqnum){
			throw AlreadyExistsException("Same seqnum in list");
		}
		if(seqnum_higher(s, seqnum)){
			break;
		}
	}
	// If we're at the end of the list, add the packet to the
	// end of the list
	if(i == m_list.end())
	{
		m_list.push_back(p);
		// Done.
		return;
	}
	// Insert before i
	m_list.insert_before(i, p);
}

void ReliablePacketBuffer::incrementTimeouts(float dtime)
{
	core::list<BufferedPacket>::Iterator i;
	i = m_list.begin();
	for(; i != m_list.end(); i++){
		i->time += dtime;
		i->totaltime += dtime;
	}
}

void ReliablePacketBuffer::resetTimedOuts(float timeout)
{
	core::list<BufferedPacket>::Iterator i;
	i = m_list.begin();
	for(; i != m_list.end(); i++){
		if(i->time >= timeout)
			i->time = 0.0;
	}
}

bool ReliablePacketBuffer::anyTotaltimeReached(float timeout)
{
	core::list<BufferedPacket>::Iterator i;
	i = m_list.begin();
	for(; i != m_list.end(); i++){
		if(i->totaltime >= timeout)
			return true;
	}
	return false;
}

core::list<BufferedPacket> ReliablePacketBuffer::getTimedOuts(float timeout)
{
	core::list<BufferedPacket> timed_outs;
	core::list<BufferedPacket>::Iterator i;
	i = m_list.begin();
	for(; i != m_list.end(); i++)
	{
		if(i->time >= timeout)
			timed_outs.push_back(*i);
	}
	return timed_outs;
}

/*
	IncomingSplitBuffer
*/

IncomingSplitBuffer::~IncomingSplitBuffer()
{
	core::map<u16, IncomingSplitPacket*>::Iterator i;
	i = m_buf.getIterator();
	for(; i.atEnd() == false; i++)
	{
		delete i.getNode()->getValue();
	}
}
/*
	This will throw a GotSplitPacketException when a full
	split packet is constructed.
*/
SharedBuffer<u8> IncomingSplitBuffer::insert(BufferedPacket &p, bool reliable)
{
	u32 headersize = BASE_HEADER_SIZE + 7;
	assert(p.data.getSize() >= headersize);
	u8 type = readU8(&p.data[BASE_HEADER_SIZE+0]);
	assert(type == TYPE_SPLIT);
	u16 seqnum = readU16(&p.data[BASE_HEADER_SIZE+1]);
	u16 chunk_count = readU16(&p.data[BASE_HEADER_SIZE+3]);
	u16 chunk_num = readU16(&p.data[BASE_HEADER_SIZE+5]);

	// Add if doesn't exist
	if(m_buf.find(seqnum) == NULL)
	{
		IncomingSplitPacket *sp = new IncomingSplitPacket();
		sp->chunk_count = chunk_count;
		sp->reliable = reliable;
		m_buf[seqnum] = sp;
	}
	
	IncomingSplitPacket *sp = m_buf[seqnum];
	
	// TODO: These errors should be thrown or something? Dunno.
	if(chunk_count != sp->chunk_count)
		derr_con<<"Connection: WARNING: chunk_count="<<chunk_count
				<<" != sp->chunk_count="<<sp->chunk_count
				<<std::endl;
	if(reliable != sp->reliable)
		derr_con<<"Connection: WARNING: reliable="<<reliable
				<<" != sp->reliable="<<sp->reliable
				<<std::endl;

	// If chunk already exists, cancel
	if(sp->chunks.find(chunk_num) != NULL)
		throw AlreadyExistsException("Chunk already in buffer");
	
	// Cut chunk data out of packet
	u32 chunkdatasize = p.data.getSize() - headersize;
	SharedBuffer<u8> chunkdata(chunkdatasize);
	memcpy(*chunkdata, &(p.data[headersize]), chunkdatasize);
	
	// Set chunk data in buffer
	sp->chunks[chunk_num] = chunkdata;
	
	// If not all chunks are received, return empty buffer
	if(sp->allReceived() == false)
		return SharedBuffer<u8>();

	// Calculate total size
	u32 totalsize = 0;
	core::map<u16, SharedBuffer<u8> >::Iterator i;
	i = sp->chunks.getIterator();
	for(; i.atEnd() == false; i++)
	{
		totalsize += i.getNode()->getValue().getSize();
	}
	
	SharedBuffer<u8> fulldata(totalsize);

	// Copy chunks to data buffer
	u32 start = 0;
	for(u32 chunk_i=0; chunk_i<sp->chunk_count;
			chunk_i++)
	{
		SharedBuffer<u8> buf = sp->chunks[chunk_i];
		u16 chunkdatasize = buf.getSize();
		memcpy(&fulldata[start], *buf, chunkdatasize);
		start += chunkdatasize;;
	}

	// Remove sp from buffer
	m_buf.remove(seqnum);
	delete sp;

	return fulldata;
}
void IncomingSplitBuffer::removeUnreliableTimedOuts(float dtime, float timeout)
{
	core::list<u16> remove_queue;
	core::map<u16, IncomingSplitPacket*>::Iterator i;
	i = m_buf.getIterator();
	for(; i.atEnd() == false; i++)
	{
		IncomingSplitPacket *p = i.getNode()->getValue();
		// Reliable ones are not removed by timeout
		if(p->reliable == true)
			continue;
		p->time += dtime;
		if(p->time >= timeout)
			remove_queue.push_back(i.getNode()->getKey());
	}
	core::list<u16>::Iterator j;
	j = remove_queue.begin();
	for(; j != remove_queue.end(); j++)
	{
		dout_con<<"NOTE: Removing timed out unreliable split packet"
				<<std::endl;
		delete m_buf[*j];
		m_buf.remove(*j);
	}
}

/*
	Channel
*/

Channel::Channel()
{
	next_outgoing_seqnum = SEQNUM_INITIAL;
	next_incoming_seqnum = SEQNUM_INITIAL;
	next_outgoing_split_seqnum = SEQNUM_INITIAL;
}
Channel::~Channel()
{
}

/*
	Peer
*/

Peer::Peer(u16 a_id, Address a_address)
{
	id = a_id;
	address = a_address;
	timeout_counter = 0.0;
	//resend_timeout = RESEND_TIMEOUT_MINIMUM;
	ping_timer = 0.0;
	resend_timeout = 0.5;
	avg_rtt = -1.0;
	has_sent_with_id = false;
}
Peer::~Peer()
{
}

void Peer::reportRTT(float rtt)
{
	if(rtt < -0.999)
	{}
	else if(avg_rtt < 0.0)
		avg_rtt = rtt;
	else
		avg_rtt = rtt * 0.1 + avg_rtt * 0.9;
	
	// Calculate resend_timeout

	/*int reliable_count = 0;
	for(int i=0; i<CHANNEL_COUNT; i++)
	{
		reliable_count += channels[i].outgoing_reliables.size();
	}
	float timeout = avg_rtt * RESEND_TIMEOUT_FACTOR
			* ((float)reliable_count * 1);*/
	
	float timeout = avg_rtt * RESEND_TIMEOUT_FACTOR;
	if(timeout < RESEND_TIMEOUT_MIN)
		timeout = RESEND_TIMEOUT_MIN;
	if(timeout > RESEND_TIMEOUT_MAX)
		timeout = RESEND_TIMEOUT_MAX;
	resend_timeout = timeout;
}
				
/*
	Connection
*/

Connection::Connection(
	u32 protocol_id,
	u32 max_packet_size,
	float timeout,
	PeerHandler *peerhandler
)
{
	assert(peerhandler != NULL);

	m_protocol_id = protocol_id;
	m_max_packet_size = max_packet_size;
	m_timeout = timeout;
	m_peer_id = PEER_ID_INEXISTENT;
	//m_waiting_new_peer_id = false;
	m_indentation = 0;
	m_peerhandler = peerhandler;
}

Connection::~Connection()
{
	// Clear peers
	core::map<u16, Peer*>::Iterator j;
	j = m_peers.getIterator();
	for(; j.atEnd() == false; j++)
	{
		Peer *peer = j.getNode()->getValue();
		delete peer;
	}
}

void Connection::Serve(unsigned short port)
{
	m_socket.Bind(port);
	m_peer_id = PEER_ID_SERVER;
}

void Connection::Connect(Address address)
{
	core::map<u16, Peer*>::Node *node = m_peers.find(PEER_ID_SERVER);
	if(node != NULL){
		throw ConnectionException("Already connected to a server");
	}

	Peer *peer = new Peer(PEER_ID_SERVER, address);
	m_peers.insert(peer->id, peer);
	m_peerhandler->peerAdded(peer);
	
	m_socket.Bind(0);
	
	// Send a dummy packet to server with peer_id = PEER_ID_INEXISTENT
	m_peer_id = PEER_ID_INEXISTENT;
	SharedBuffer<u8> data(0);
	Send(PEER_ID_SERVER, 0, data, true);

	//m_waiting_new_peer_id = true;
}

void Connection::Disconnect()
{
	// Create and send DISCO packet
	SharedBuffer<u8> data(2);
	writeU8(&data[0], TYPE_CONTROL);
	writeU8(&data[1], CONTROLTYPE_DISCO);
	
	// Send to all
	core::map<u16, Peer*>::Iterator j;
	j = m_peers.getIterator();
	for(; j.atEnd() == false; j++)
	{
		Peer *peer = j.getNode()->getValue();
		SendAsPacket(peer->id, 0, data, false);
	}
}

bool Connection::Connected()
{
	if(m_peers.size() != 1)
		return false;
		
	core::map<u16, Peer*>::Node *node = m_peers.find(PEER_ID_SERVER);
	if(node == NULL)
		return false;
	
	if(m_peer_id == PEER_ID_INEXISTENT)
		return false;
	
	return true;
}

SharedBuffer<u8> Channel::ProcessPacket(
		SharedBuffer<u8> packetdata,
		Connection *con,
		u16 peer_id,
		u8 channelnum,
		bool reliable)
{
	IndentationRaiser iraiser(&(con->m_indentation));

	if(packetdata.getSize() < 1)
		throw InvalidIncomingDataException("packetdata.getSize() < 1");

	u8 type = readU8(&packetdata[0]);
	
	if(type == TYPE_CONTROL)
	{
		if(packetdata.getSize() < 2)
			throw InvalidIncomingDataException("packetdata.getSize() < 2");

		u8 controltype = readU8(&packetdata[1]);

		if(controltype == CONTROLTYPE_ACK)
		{
			if(packetdata.getSize() < 4)
				throw InvalidIncomingDataException
						("packetdata.getSize() < 4 (ACK header size)");

			u16 seqnum = readU16(&packetdata[2]);
			con->PrintInfo();
			dout_con<<"Got CONTROLTYPE_ACK: channelnum="
					<<((int)channelnum&0xff)<<", peer_id="<<peer_id
					<<", seqnum="<<seqnum<<std::endl;

			try{
				BufferedPacket p = outgoing_reliables.popSeqnum(seqnum);
				// Get round trip time
				float rtt = p.totaltime;

				// Let peer calculate stuff according to it
				// (avg_rtt and resend_timeout)
				Peer *peer = con->GetPeer(peer_id);
				peer->reportRTT(rtt);

				//con->PrintInfo(dout_con);
				//dout_con<<"RTT = "<<rtt<<std::endl;

				/*dout_con<<"OUTGOING: ";
				con->PrintInfo();
				outgoing_reliables.print();
				dout_con<<std::endl;*/
			}
			catch(NotFoundException &e){
				con->PrintInfo(derr_con);
				derr_con<<"WARNING: ACKed packet not "
						"in outgoing queue"
						<<std::endl;
			}

			throw ProcessedSilentlyException("Got an ACK");
		}
</span>
<span class="hl com">GNU Lesser General Public License for more details.</span>
<span class="hl com"></span>
<span class="hl com">You should have received a copy of the GNU Lesser General Public License along</span>
<span class="hl com">with this program; if not, write to the Free Software Foundation, Inc.,</span>
<span class="hl com">51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<span class="hl com">*/</span>

<span class="hl ppc">#include</span> <span class="hl pps">&quot;joystick_controller.h&quot;</span><span class="hl ppc"></span>
<span class="hl ppc">#include</span> <span class="hl pps">&quot;irrlichttypes_extrabloated.h&quot;</span><span class="hl ppc"></span>
<span class="hl ppc">#include</span> <span class="hl pps">&quot;keys.h&quot;</span><span class="hl ppc"></span>
<span class="hl ppc">#include</span> <span class="hl pps">&quot;settings.h&quot;</span><span class="hl ppc"></span>
<span class="hl ppc">#include</span> <span class="hl pps">&quot;gettime.h&quot;</span><span class="hl ppc"></span>
<span class="hl ppc">#include</span> <span class="hl pps">&quot;porting.h&quot;</span><span class="hl ppc"></span>
<span class="hl ppc">#include</span> <span class="hl pps">&quot;util/string.h&quot;</span><span class="hl ppc"></span>
<span class="hl ppc">#include</span> <span class="hl pps">&quot;util/numeric.h&quot;</span><span class="hl ppc"></span>

<span class="hl kwb">bool</span> <span class="hl kwc">JoystickButtonCmb</span><span class="hl opt">::</span><span class="hl kwd">isTriggered</span><span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">irr</span><span class="hl opt">::</span><span class="hl kwc">SEvent</span><span class="hl opt">::</span>SJoystickEvent <span class="hl opt">&amp;</span>ev<span class="hl opt">)</span> <span class="hl kwb">const</span>
<span class="hl opt">{</span>
	u32 buttons <span class="hl opt">=</span> ev<span class="hl opt">.</span>ButtonStates<span class="hl opt">;</span>

	buttons <span class="hl opt">&amp;=</span> filter_mask<span class="hl opt">;</span>
	<span class="hl kwa">return</span> buttons <span class="hl opt">==</span> compare_mask<span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl kwb">bool</span> <span class="hl kwc">JoystickAxisCmb</span><span class="hl opt">::</span><span class="hl kwd">isTriggered</span><span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">irr</span><span class="hl opt">::</span><span class="hl kwc">SEvent</span><span class="hl opt">::</span>SJoystickEvent <span class="hl opt">&amp;</span>ev<span class="hl opt">)</span> <span class="hl kwb">const</span>
<span class="hl opt">{</span>
	s16 ax_val <span class="hl opt">=</span> ev<span class="hl opt">.</span>Axis<span class="hl opt">[</span>axis_to_compare<span class="hl opt">];</span>

	<span class="hl kwa">return</span> <span class="hl opt">(</span>ax_val <span class="hl opt">*</span> direction <span class="hl opt">&lt; -</span>thresh<span class="hl opt">);</span>
<span class="hl opt">}</span>

<span class="hl slc">// spares many characters</span>
<span class="hl ppc">#define JLO_B_PB(A, B, C)    jlo.button_keys.emplace_back(A, B, C)</span>
<span class="hl ppc">#define JLO_A_PB(A, B, C, D) jlo.axis_keys.emplace_back(A, B, C, D)</span>

JoystickLayout <span class="hl kwd">create_default_layout</span><span class="hl opt">()</span>
<span class="hl opt">{</span>
	JoystickLayout jlo<span class="hl opt">;</span>

	jlo<span class="hl opt">.</span>axes_deadzone <span class="hl opt">=</span> g_settings<span class="hl opt">-&gt;</span><span class="hl kwd">getU16</span><span class="hl opt">(</span><span class="hl str">&quot;joystick_deadzone&quot;</span><span class="hl opt">);</span>

	<span class="hl kwb">const</span> JoystickAxisLayout axes<span class="hl opt">[</span>JA_COUNT<span class="hl opt">] = {</span>
		<span class="hl opt">{</span><span class="hl num">0</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_SIDEWARD_MOVE</span>
		<span class="hl opt">{</span><span class="hl num">1</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_FORWARD_MOVE</span>
		<span class="hl opt">{</span><span class="hl num">3</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_FRUSTUM_HORIZONTAL</span>
		<span class="hl opt">{</span><span class="hl num">4</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_FRUSTUM_VERTICAL</span>
	<span class="hl opt">};</span>
	<span class="hl kwd">memcpy</span><span class="hl opt">(</span>jlo<span class="hl opt">.</span>axes<span class="hl opt">,</span> axes<span class="hl opt">,</span> <span class="hl kwa">sizeof</span><span class="hl opt">(</span>jlo<span class="hl opt">.</span>axes<span class="hl opt">));</span>

	u32 sb <span class="hl opt">=</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">7</span><span class="hl opt">;</span> <span class="hl slc">// START button mask</span>
	u32 fb <span class="hl opt">=</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">3</span><span class="hl opt">;</span> <span class="hl slc">// FOUR button mask</span>
	u32 bm <span class="hl opt">=</span> sb <span class="hl opt">|</span> fb<span class="hl opt">;</span> <span class="hl slc">// Mask for Both Modifiers</span>

	<span class="hl slc">// The back button means &quot;ESC&quot;.</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>ESC<span class="hl opt">,</span>        <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">6</span><span class="hl opt">,</span>      <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">6</span><span class="hl opt">);</span>

	<span class="hl slc">// The start button counts as modifier as well as use key.</span>
	<span class="hl slc">// JLO_B_PB(KeyType::USE,        sb,          sb));</span>

	<span class="hl slc">// Accessible without start modifier button pressed</span>
	<span class="hl slc">// regardless whether four is pressed or not</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>SNEAK<span class="hl opt">,</span>      sb <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">2</span><span class="hl opt">,</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">2</span><span class="hl opt">);</span>

	<span class="hl slc">// Accessible without four modifier button pressed</span>
	<span class="hl slc">// regardless whether start is pressed or not</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>DIG<span class="hl opt">,</span>        fb <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">4</span><span class="hl opt">,</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">4</span><span class="hl opt">);</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>PLACE<span class="hl opt">,</span>      fb <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">5</span><span class="hl opt">,</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">5</span><span class="hl opt">);</span>

	<span class="hl slc">// Accessible without any modifier pressed</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>JUMP<span class="hl opt">,</span>       bm <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">0</span><span class="hl opt">,</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">0</span><span class="hl opt">);</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>AUX1<span class="hl opt">,</span>       bm <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">1</span><span class="hl opt">,</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">1</span><span class="hl opt">);</span>

	<span class="hl slc">// Accessible with start button not pressed, but four pressed</span>
	<span class="hl slc">// TODO find usage for button 0</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>DROP<span class="hl opt">,</span>        bm <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">1</span><span class="hl opt">,</span> fb <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>HOTBAR_PREV<span class="hl opt">,</span> bm <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">4</span><span class="hl opt">,</span> fb <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">4</span><span class="hl opt">);</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>HOTBAR_NEXT<span class="hl opt">,</span> bm <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">5</span><span class="hl opt">,</span> fb <span class="hl opt">|</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">5</span><span class="hl opt">);</span>

	<span class="hl slc">// Accessible with start button and four pressed</span>
	<span class="hl slc">// TODO find usage for buttons 0, 1 and 4, 5</span>

	<span class="hl slc">// Now about the buttons simulated by the axes</span>

	<span class="hl slc">// Movement buttons, important for vessels</span>
	<span class="hl kwd">JLO_A_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>FORWARD<span class="hl opt">,</span>  <span class="hl num">1</span><span class="hl opt">,</span>  <span class="hl num">1</span><span class="hl opt">,</span> jlo<span class="hl opt">.</span>axes_deadzone<span class="hl opt">);</span>
	<span class="hl kwd">JLO_A_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>BACKWARD<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">, -</span><span class="hl num">1</span><span class="hl opt">,</span> jlo<span class="hl opt">.</span>axes_deadzone<span class="hl opt">);</span>
	<span class="hl kwd">JLO_A_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>LEFT<span class="hl opt">,</span>     <span class="hl num">0</span><span class="hl opt">,</span>  <span class="hl num">1</span><span class="hl opt">,</span> jlo<span class="hl opt">.</span>axes_deadzone<span class="hl opt">);</span>
	<span class="hl kwd">JLO_A_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>RIGHT<span class="hl opt">,</span>    <span class="hl num">0</span><span class="hl opt">, -</span><span class="hl num">1</span><span class="hl opt">,</span> jlo<span class="hl opt">.</span>axes_deadzone<span class="hl opt">);</span>

	<span class="hl slc">// Scroll buttons</span>
	<span class="hl kwd">JLO_A_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>HOTBAR_PREV<span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">, -</span><span class="hl num">1</span><span class="hl opt">,</span> jlo<span class="hl opt">.</span>axes_deadzone<span class="hl opt">);</span>
	<span class="hl kwd">JLO_A_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>HOTBAR_NEXT<span class="hl opt">,</span> <span class="hl num">5</span><span class="hl opt">, -</span><span class="hl num">1</span><span class="hl opt">,</span> jlo<span class="hl opt">.</span>axes_deadzone<span class="hl opt">);</span>

	<span class="hl kwa">return</span> jlo<span class="hl opt">;</span>
<span class="hl opt">}</span>

JoystickLayout <span class="hl kwd">create_xbox_layout</span><span class="hl opt">()</span>
<span class="hl opt">{</span>
	JoystickLayout jlo<span class="hl opt">;</span>

	jlo<span class="hl opt">.</span>axes_deadzone <span class="hl opt">=</span> <span class="hl num">7000</span><span class="hl opt">;</span>

	<span class="hl kwb">const</span> JoystickAxisLayout axes<span class="hl opt">[</span>JA_COUNT<span class="hl opt">] = {</span>
		<span class="hl opt">{</span><span class="hl num">0</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_SIDEWARD_MOVE</span>
		<span class="hl opt">{</span><span class="hl num">1</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_FORWARD_MOVE</span>
		<span class="hl opt">{</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_FRUSTUM_HORIZONTAL</span>
		<span class="hl opt">{</span><span class="hl num">3</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">},</span> <span class="hl slc">// JA_FRUSTUM_VERTICAL</span>
	<span class="hl opt">};</span>
	<span class="hl kwd">memcpy</span><span class="hl opt">(</span>jlo<span class="hl opt">.</span>axes<span class="hl opt">,</span> axes<span class="hl opt">,</span> <span class="hl kwa">sizeof</span><span class="hl opt">(</span>jlo<span class="hl opt">.</span>axes<span class="hl opt">));</span>

	<span class="hl slc">// The back button means &quot;ESC&quot;.</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>ESC<span class="hl opt">,</span>        <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">8</span><span class="hl opt">,</span>  <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">8</span><span class="hl opt">);</span> <span class="hl slc">// back</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>ESC<span class="hl opt">,</span>        <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">9</span><span class="hl opt">,</span>  <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">9</span><span class="hl opt">);</span> <span class="hl slc">// start</span>

	<span class="hl slc">// 4 Buttons</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>JUMP<span class="hl opt">,</span>        <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">0</span><span class="hl opt">,</span>  <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">0</span><span class="hl opt">);</span> <span class="hl slc">// A/green</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>ESC<span class="hl opt">,</span>         <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">1</span><span class="hl opt">,</span>  <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">1</span><span class="hl opt">);</span> <span class="hl slc">// B/red</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>AUX1<span class="hl opt">,</span>        <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">2</span><span class="hl opt">,</span>  <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">2</span><span class="hl opt">);</span> <span class="hl slc">// X/blue</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>INVENTORY<span class="hl opt">,</span>   <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">3</span><span class="hl opt">,</span>  <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">3</span><span class="hl opt">);</span> <span class="hl slc">// Y/yellow</span>

	<span class="hl slc">// Analog Sticks</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>AUX1<span class="hl opt">,</span>        <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">11</span><span class="hl opt">,</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">11</span><span class="hl opt">);</span> <span class="hl slc">// left</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>SNEAK<span class="hl opt">,</span>       <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">12</span><span class="hl opt">,</span> <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">12</span><span class="hl opt">);</span> <span class="hl slc">// right</span>

	<span class="hl slc">// Triggers</span>
	<span class="hl kwd">JLO_B_PB</span><span class="hl opt">(</span><span class="hl kwc">KeyType</span><span class="hl opt">::</span>DIG<span class="hl opt">,</span>         <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">6</span><span class="hl opt">,</span>  <span class="hl num">1</span> <span class="hl opt">&lt;&lt;</span> <span class="hl num">6</span><span class="hl opt">);</span>