Invercargill/src/lib/Enumerable.vala

namespace Invercargill {

    public abstract class Enumerable<T> : Object {

        public abstract Tracker<T> get_tracker();

        // Returns false if iteration was interrupted
        // Returns true if iteration reached natural end
        public virtual bool iterate_if(PredicateDelegate<T> handler) {
            var tracker = get_tracker();
            while(tracker.has_next()) {
                if(!handler(tracker.get_next())) {
                    return false;
                }
            }
            return true;
        }

        public virtual void iterate(ItemDelegate<T> handler) {
            iterate_if(i => {
                handler(i);
                return true;
            });
        }

        public virtual Sequence<T> to_sequence() {
            var sequence = new Sequence<T>();
            iterate(i => sequence.add(i));
            return sequence;
        }

        public virtual Gee.Collection<T> to_collection() {
            var collection = new Gee.LinkedList<T>();
            iterate(i => collection.add(i));
            return collection;
        }

        public virtual Tracker<T> iterator() {
            return get_tracker();
        }

        public virtual T[] to_array() {
            return to_collection().to_array();
        }

        public virtual int count() {
            var count = 0;
            iterate(i => count++);
            return count;
        }

        public virtual bool any(PredicateDelegate<T> predicate = (i) => true) {
            var result = false;
            iterate_if(i => {
                if(predicate(i)) {
                    result = true;
                    return false;
                }
                return true;
            });

            return result;
        }

        public virtual bool all(PredicateDelegate<T> predicate) {
            return !any(i => !predicate(i));
        }

        public virtual bool no(PredicateDelegate<T> predicate = (i) => true) {
            return all(i => !predicate(i));
        }

        public virtual Enumerable<T> where(owned PredicateDelegate<T> predicate) {
            return new FilterQuery<T>(this, (owned)predicate);
        }

        public virtual Enumerable<Tout> select<Tout>(owned TransformDelegate<T, Tout> transform) {
            return new TransformQuery<T, Tout>(this, (owned)transform);
        }

        public virtual Enumerable<Tout> select_many<Tout>(owned TransformDelegate<T, Enumerable<Tout>> transform) {
            return new MergeQuery<Tout>(select((owned)transform));
        }

        public virtual Enumerable<T> sort(owned CompareDelegate<T> compare) {
            return new SortQuery<T>(this, (owned)compare);
        }

        public virtual Enumerable<T> concat(Enumerable<T> other) {
            return new ConcatEnumerable<T>(this, other);
        }

        public virtual Enumerable<T> take(int count) {
            return new TakeQuery<T>(this, count);
        }

        public virtual Enumerable<T> skip(int count) {
            return new SkipQuery<T>(this, count);
        }

        public virtual Enumerable<Tout> cast<Tout>() {
            return select<Tout>(i => (Tout)i);
        }

        public virtual Enumerable<Tout> parallel_select<Tout>(owned TransformDelegate<T, Tout> transform, uint workers = 0) {
            var actual_workers = workers;
            if(actual_workers < 1) {
                actual_workers = get_num_processors();
            }
            return new ParallelQuery<T, Tout>(this, (owned)transform, (int)actual_workers);
        }

        public virtual int parallel_iterate(ItemDelegate<T> handler, uint workers = 0) {
            return parallel_select<T>(i => {
                handler(i);
                return i;
            }, workers)
            .count();
        }

        public virtual Enumerable<SelectionContext<T, Tout>> contextualised_select<Tout>(owned TransformDelegate<T, Tout> transform) {
            return new TransformQuery<T, SelectionContext<T, Tout>>(this, (i) => new SelectionContext<T, Tout>() {
                origin = i,
                result = transform(i)
            });
        }

        public virtual Tout aggrigate<Tout>(Tout initial, AggrigateDelegate<Tout, T> aggrigate_func) {
            var aggrigate = initial;
            iterate(i => {
                aggrigate = aggrigate_func(aggrigate, i);
            });
            return aggrigate;
        }

        public virtual bool contains(T item) {
            return any(i => i == item);
        }

        public virtual Enumerable<Pair<T, Tother>> pair<Tother>(Enumerable<Tother> other) {
            return new PairEnumerable<T, Tother>(this, other);
        }

        public virtual Enumerable<T> zip(Enumerable<T> other) {
            return new ZipperEnumerable<T>(this, other);
        }

        public virtual Enumerable<Tout> fork<Tout>(owned TransformDelegate<T, Tout> fork1, owned TransformDelegate<T, Tout> fork2) {
            var seq = to_sequence();
            return seq.select<Tout>((owned)fork1).zip(seq.select<Tout>((owned)fork2));
        }

        public virtual Enumerable<Tout> fork_many<Tout>(owned TransformDelegate<T, Enumerable<Tout>> fork1, owned TransformDelegate<T, Enumerable<Tout>> fork2) {
            return new MergeQuery<Tout>(fork((owned)fork1, (owned)fork2));
        }

        public virtual bool matches(Enumerable<T> other, EqualityDelegate<T> equals) {
            return pair(other).all(p => equals(p.value1, p.value2));
        }

        public virtual Enumerable<T> with(T item) {
            var seq = new Sequence<T>();
            seq.add(item);
            return concat(seq);
        }

        public virtual T first(owned PredicateDelegate<T>? predicate = null) throws SequenceError {
            var tracker = predicate == null ? get_tracker() : where((owned)predicate).get_tracker();
            if(tracker.has_next()) {
                return tracker.get_next();
            }
            throw new SequenceError.NO_ELEMENTS("The sequence contains no elements");
        }

        public virtual T? first_or_default(owned PredicateDelegate<T>? predicate = null) {
            var tracker = predicate == null ? get_tracker() : where((owned)predicate).get_tracker();
            if(tracker.has_next()) {
                return tracker.get_next();
            }
            return null;
        }

        public virtual T single(owned PredicateDelegate<T>? predicate = null) throws SequenceError {
            var tracker = predicate == null ? get_tracker() : where((owned)predicate).get_tracker();
            if(tracker.has_next()) {
                var item = tracker.get_next();
                if(tracker.has_next()) {
                    throw new SequenceError.MULTUPLE_ELEMENTS("The sequence contains more than one element");
                }
                return item;
            }
            throw new SequenceError.NO_ELEMENTS("The sequence contains no elements");
        }

        public virtual T single_or_default(owned PredicateDelegate<T>? predicate = null) throws SequenceError {
            var tracker = predicate == null ? get_tracker() : where((owned)predicate).get_tracker();
            if(tracker.has_next()) {
                var item = tracker.get_next();
                if(tracker.has_next()) {
                    throw new SequenceError.MULTUPLE_ELEMENTS("The sequence contains more than one element");
                }
                return item;
            }
            return null;
        }

        public virtual string to_string(TransformDelegate<T, string> stringifier, string seperator = "") {
            bool is_first = true;
            return aggrigate<string>("", (s, v) => {
                if(is_first) {
                    is_first = false;
                    return stringifier(v);
                }
                return s + seperator + stringifier(v);
            });
        }

        public virtual Object[] to_object_array() throws SequenceError {
            if(!typeof(T).is_object()) {
                throw new SequenceError.INVALID_TYPE("Can only make an object array of an Enumerable<T> where T is derrived from GLib.Object");
            }
            return select<Object>(i => (Object)i).to_array();
        }

    }

}