tbd-station-14/Content.Shared/Markings/MarkingsSet.cs

using System.Collections;
using System.Linq;
using Robust.Shared.Serialization;

namespace Content.Shared.Markings;

// TODO: Maybe put points logic into here too? It would make some sense
// but it would have to be a template loaded in, otherwise clients could
// send really invalid points sets that would have to be verified on the
// server/client every time
//
// currently marking point constraints are just validated upon data send
// from the client's UI (which might be a nono, means that connections
// can just send garbage marking sets and it will save on the server)
// and when an entity is rendered, (which is OK enough)
//
// equally, we'd need to access references every time we wanted to get
// the managers required, which... not *terrible* if we do null default
// params
[Serializable, NetSerializable]
public class MarkingsSet : IEnumerable, IEquatable<MarkingsSet>
{
    // if you want a rust style VecDeque, you're looking at
    // the wrong place, i just wanted a similar API + some
    // markings specific functions
    private List<Marking> _markings = new();

    public int Count
    {
        get => _markings.Count;
    }

    public MarkingsSet()
    {
    }

    public MarkingsSet(List<Marking> markings)
    {
        _markings = markings;
    }

    public MarkingsSet(MarkingsSet other)
    {
        _markings = new(other._markings);
    }

    public Marking this[int idx] => Index(idx);

    public Marking Index(int idx)
    {
        return _markings[idx];
    }

    // Gets a marking idx spaces from the back of the list.
    public Marking IndexReverse(int idx)
    {
        return _markings[_markings.Count - 1 - idx];
    }

    public void AddFront(Marking marking)
    {
        _markings.Insert(0, marking);
    }

    public void AddBack(Marking marking)
    {
        _markings.Add(marking);
    }

    public bool Remove(Marking marking)
    {
        return _markings.Remove(marking);
    }

    public bool Contains(Marking marking)
    {
        return _markings.Contains(marking);
    }

    public int FindIndexOf(string id)
    {
        return _markings.FindIndex(m => m.MarkingId == id);
    }

    // Shifts a marking's rank upwards (i.e., towards the front of the list)
    public void ShiftRankUp(int idx)
    {
        if (idx < 0 || idx >= _markings.Count || idx - 1 < 0)
        {
            return;
        }

        var temp = _markings[idx - 1];
        _markings[idx - 1] = _markings[idx];
        _markings[idx] = temp;
    }

    // Shifts up from the back (i.e., 2nd position from end)
    public void ShiftRankUpFromEnd(int idx)
    {
        ShiftRankUp(Count - idx - 1);
    }

    // Ditto, but the opposite direction.
    public void ShiftRankDown(int idx)
    {
        if (idx < 0 || idx >= _markings.Count || idx + 1 >= _markings.Count)
        {
            return;
        }

        var temp = _markings[idx + 1];
        _markings[idx + 1] = _markings[idx];
        _markings[idx] = temp;
    }

    // Ditto as above.
    public void ShiftRankDownFromEnd(int idx)
    {
        ShiftRankDown(Count - idx - 1);
    }

    // Ensures that all markings in a set are valid.
    public static MarkingsSet EnsureValid(MarkingsSet set, MarkingManager? manager = null)
    {
        IoCManager.Resolve(ref manager);

        for (var i = set._markings.Count - 1; i >= 0; i--)
        {
            var marking = set._markings[i];
            if (manager.IsValidMarking(marking, out var markingProto))
            {
                if (marking.MarkingColors.Count != markingProto.Sprites.Count)
                {
                    set._markings[i] = new Marking(marking.MarkingId, markingProto.Sprites.Count);
                }
            }
            else
            {
                set._markings.RemoveAt(i);
            }
        }

        return set;
    }

    // Filters out markings based on species.
    public static MarkingsSet FilterSpecies(MarkingsSet set, string species, MarkingManager? manager = null)
    {
        IoCManager.Resolve(ref manager);
        var newList = set._markings.Where(marking =>
        {
            if (!manager.Markings().TryGetValue(marking.MarkingId, out MarkingPrototype? prototype))
            {
                return false;
            }

            if (prototype.SpeciesRestrictions != null)
            {
                if (!prototype.SpeciesRestrictions.Contains(species))
                {
                    return false;
                }
            }

            return true;
        }).ToList();

        set._markings = newList;

        return set;
    }

    // Processes a MarkingsSet using the given dictionary of MarkingPoints.
    public static MarkingsSet ProcessPoints(MarkingsSet set, Dictionary<MarkingCategories, MarkingPoints> points, MarkingManager? manager = null)
    {
        IoCManager.Resolve(ref manager);
        var finalSet = new List<Marking>();

        foreach (var marking in set)
        {
            if (manager.Markings().TryGetValue(marking.MarkingId, out MarkingPrototype? markingPrototype))
            {
                if (points.TryGetValue(markingPrototype.MarkingCategory, out var pointsRemaining))
                {
                    if (pointsRemaining.Points == 0)
                    {
                        continue;
                    }

                    pointsRemaining.Points--;

                    finalSet.Add(marking);
                }
                else
                {
                    // points don't exist otherwise
                    finalSet.Add(marking);
                }
            }
        }

        set._markings = finalSet;

        return set;
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        return (IEnumerator) GetEnumerator();
    }

    public MarkingsEnumerator GetEnumerator()
    {
        return new MarkingsEnumerator(_markings, false);
    }

    public IEnumerator GetReverseEnumerator()
    {
        return (IEnumerator) new MarkingsEnumerator(_markings, true);
    }

    public bool Equals(MarkingsSet? set)
    {
        if (set == null)
        {
            return false;
        }

        return _markings.SequenceEqual(set._markings);
    }
}

public class MarkingsEnumerator : IEnumerator
{
    private List<Marking> _markings;
    private bool _reverse;

    int position;

    public MarkingsEnumerator(List<Marking> markings, bool reverse)
    {
        _markings = markings;
        _reverse = reverse;

        if (_reverse)
        {
            position = _markings.Count;
        }
        else
        {
            position = -1;
        }
    }

    public bool MoveNext()
    {
        if (_reverse)
        {
            position--;
            return (position >= 0);
        }
        else
        {
            position++;
            return (position < _markings.Count);
        }
    }

    public void Reset()
    {
        if (_reverse)
        {
            position = _markings.Count;
        }
        else
        {
            position = -1;
        }
    }

    object IEnumerator.Current
    {
        get => _markings[position];
    }

    public Marking Current
    {
        get => _markings[position];
    }
}