list.h

/* Copyright (c) 2024 Julian Benda
 *
 * This file is part of inkCPP which is released under MIT license.
 * See file LICENSE.txt or go to
 * https://github.com/JBenda/inkcpp for full license details.
 */
#pragma once
 
#include "system.h"
 
#ifdef INK_ENABLE_STL
#   include <ostream>
#endif
 
#ifdef INKCPP_BUILD_CLIB
struct InkListIter;
struct HInkList;
int ink_list_flags(const HInkList*, InkListIter*);
int ink_list_flags_from(const HInkList*, const char*, InkListIter*);
int ink_list_iter_next(InkListIter*);
#endif
 
namespace ink::runtime
{
namespace internal
{
    class list_table;
} // namespace internal

class list_interface
{
public:
    list_interface()
        : _list_table{nullptr}
        , _list{-1}
    {
    }

    virtual list_interface& operator=(const list_interface&) = default;
 
    virtual ~list_interface() {}

    class iterator
    {
        const char*           _flag_name;
        const char*           _list_name;
        const list_interface& _list;
        int                   _i;
        bool                  _one_list_iterator; 
        friend list_interface;
#ifdef INKCPP_BUILD_CLIB
        friend int ::ink_list_flags(const HInkList*, InkListIter*);
        friend int ::ink_list_flags_from(const HInkList*, const char*, InkListIter*);
        friend int ::ink_list_iter_next(InkListIter* self);
#endif
 
    protected:
        iterator(const char* flag_name, const list_interface& list, int i, bool one_list_only = false)
            : _flag_name(flag_name)
            , _list_name(nullptr)
            , _list(list)
            , _i(i)
            , _one_list_iterator(one_list_only)
        {
        }
 
    public:
        iterator(const iterator&) = default;

        struct Flag {
            const char* flag_name; 
            const char* list_name; 
#ifdef INK_ENABLE_STL
            friend std::ostream& operator<<(std::ostream& os, const Flag& flag)
            {
                os << flag.list_name << "(" << flag.flag_name << ")";
                return os;
            }
#endif
        };

        Flag operator*() const { return Flag{_flag_name, _list_name}; };

        iterator& operator++()
        {
            _list.next(_flag_name, _list_name, _i, _one_list_iterator);
            return *this;
        }

        bool operator!=(const iterator& itr) const { return itr._i != _i; }

        bool operator==(const iterator& itr) const { return itr._i == _i; }
 
        iterator& operator=(const iterator&) = delete;
    };
 
 
#ifdef __GNUC__
#   pragma GCC diagnostic push
#   pragma GCC diagnostic ignored "-Wunused-parameter"
#else
#   pragma warning(push)
// non functional prototypes do not need the argument.
#   pragma warning(disable : 4100)
#endif

    virtual bool contains(const char* flag) const
    {
        inkAssert(false, "Not implemented function from interfaces is called!");
        return false;
    };

    virtual void add(const char* flag)
    {
        inkAssert(false, "Not implemented function from interface is called!");
    };

    virtual void remove(const char* flag)
    {
        inkAssert(false, "Not implemented function from interface is called!");
    };

    virtual iterator begin() const
    {
        inkAssert(false, "Not implemented function from interface is called!");
        return new_iterator(nullptr, -1);
    };

    virtual iterator begin(const char* list_name) const
    {
        inkAssert(false, "Not implemented function from interface is called!");
        return new_iterator(nullptr, -1);
    }

    virtual iterator end() const
    {
        inkAssert(false, "Not implemented function from interface is called!");
        return new_iterator(nullptr, -1);
    };
 
private:
    friend iterator;
 
    virtual void
        next(const char*& flag_name, const char*& list_name, int& i, bool _one_list_iterator) const
    {
        inkAssert(false, "Not implemented funciton from interface is called!");
    };
 
#ifdef __GNUC__
#   pragma GCC diagnostic pop
#else
#   pragma warning(pop)
#endif
 
protected:
    iterator new_iterator(const char* flag_name, int i, bool one_list_only = false) const
    {
        return iterator(flag_name, *this, i, one_list_only);
    }

    list_interface(internal::list_table& table, int list)
        : _list_table{&table}
        , _list{list}
    {
    }

    internal::list_table* _list_table;
    int                   _list;
};
 
} // namespace ink::runtime