/**
 * ae.utils.meta.chain
 *
 * License:
 *   This Source Code Form is subject to the terms of
 *   the Mozilla Public License, v. 2.0. If a copy of
 *   the MPL was not distributed with this file, You
 *   can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Authors:
 *   Vladimir Panteleev <ae@cy.md>
 */

/// Chains are a concept a bit like ranges,
/// but which operate on heterogeneous types
/// (e.g. a tuple of values).

/// Composition is done by a chain of functors.
/// To allow state, each functor can be represented
/// as a struct.

/// Functors return a bool (true if iteration should
/// stop, false if it should continue).

deprecated("Use ae.utils.meta.tuplerange")
module ae.utils.meta.chain;

import ae.utils.meta.caps;

///
static if (haveAliasStructBinding)
unittest
{
	int a = 2;
	int x;
	chainIterator(chainFilter!(n => n > a)((int n) { x = n; return true; } ))(1, 2, 3);
	assert(x == 3);
}

static if (haveAliasStructBinding)
unittest
{
	static struct X
	{
		bool fun(int x)
		{
			return chainIterator(chainFunctor!(n => n == x))(this.tupleof);
		}

		long a;
		int b;
		ubyte c;
	}

	X x;
	assert(!x.fun(5));
	x.c = 5;
	assert(x.fun(5));
}

/// Starts the chain by iterating over a tuple.
struct ChainIterator(Next)
{
	Next next; ///

	this(ref Next next)
	{
		this.next = next;
	} ///

	bool opCall(Args...)(auto ref Args args)
	{
		foreach (ref arg; args)
			if (next(arg))
				return true;
		return false;
	} ///
}
auto chainIterator(Next)(Next next)
{
	return ChainIterator!Next(next);
} /// ditto

unittest
{
	struct S
	{
		int a = 1;
		long b = 2;
		ubyte c = 3;
	}
	S s;

	int[] results;
	chainIterator((long n) { results ~= cast(int)n; return  false; })(s.tupleof);
	assert(results == [1, 2, 3]);
}

/// Wraps a function template into a concrete value type functor.
struct ChainFunctor(alias fun)
{
	auto opCall(Arg)(auto ref Arg arg)
	{
		return fun(arg);
	} ///
}
auto chainFunctor(alias fun)()
{
	ChainFunctor!fun s;
	return s;
} /// ditto

///
static if (haveAliasStructBinding)
unittest
{
	int[] results;
	auto fn = chainFunctor!(n => results ~= cast(int)n);
	fn(1);
	fn(long(2));
	fn(ubyte(3));
	assert(results == [1, 2, 3]);
}

/// Calls next only if pred(value) is true.
struct ChainFilter(alias pred, Next)
{
	Next next; ///

	this(Next next) { this.next = next; } ///

	bool opCall(T)(auto ref T v)
	{
		if (pred(v))
			return next(v);
		return false;
	} ///
}
template chainFilter(alias pred)
{
	auto chainFilter(Next)(Next next)
	{
		return ChainFilter!(pred, Next)(next);
	}
} /// ditto

/// Iteration control.
struct ChainControl(bool result, Next)
{
	Next next; ///

	this(Next next) { this.next = next; } ///

	bool opCall(T)(auto ref T v)
	{
		cast(void)next(v);
		return result;
	} ///
}
template chainControl(bool result)
{
	auto chainControl(Next)(Next next)
	{
		return ChainControl!(result, Next)(next);
	}
} ///
alias chainAll = chainControl!false; /// Always continue iteration
alias chainFirst = chainControl!true; /// Stop iteration after this element

///
static if (haveAliasStructBinding)
unittest
{
	int a = 2;
	int b = 3;
	int[] results;
	foreach (i; 0..10)
		chainFilter!(n => n % a == 0)(
			chainFilter!(n => n % b == 0)(
				(int n) { results ~= n; return false; }))(i);
	assert(results == [0, 6]);
}

/// Calls next with pred(value).
struct ChainMap(alias pred, Next)
{
	Next next; ///

	this(Next next) { this.next = next; } ///

	bool opCall(T)(auto ref T v)
	{
		return next(pred(v));
	} ///
}
template chainMap(alias pred)
{
	auto chainMap(Next)(Next next)
	{
		return ChainMap!(pred, Next)(next);
	}
} /// ditto

///
unittest
{
	int result;
	chainMap!(n => n+1)(chainMap!(n => n * 2)((int n) { result = n; return false; }))(2);
	assert(result == 6);
}