MuditaOS/module-gui/gui/widgets/ListView.cpp

/*
 * ListView.cpp
 *
 *  Created on: 11 mar 2019
 *      Author: robert
 */
#include <algorithm>

#include "ListView.hpp"
#include <log/log.hpp>

namespace gui
{

    ListView::ListView()
        : firstIndex{0}, lastIndex{0}, elementsCount{4}, drawSeparators{true}, drawVerticalScroll{true},
          orientation{ListView::ORIENTATION_TOP_DOWN}, maxElements{4},
          selectedIndex{0}, listMode{ListView::MODE_PAGE}, pageSize{4}
    {

        setPenFocusWidth(0);
        setPenWidth(0);

        scroll = new Rect(this,
                          style::listview::scroll_x,
                          style::listview::scroll_y,
                          style::listview::scroll_w,
                          style::listview::scroll_h);
        scroll->setRadius(style::listview::scroll_radius);
        scroll->setFilled(style::listview::scroll_fill);
        scroll->setFillColor(style::listview::scroll_color);
    }

    ListView::ListView(Item *parent, uint32_t x, uint32_t y, uint32_t w, uint32_t h)
        : Rect{parent, x, y, w, h}, firstIndex{0}, lastIndex{0}, elementsCount{4}, drawSeparators{true},
          drawVerticalScroll{true}, orientation{ListView::ORIENTATION_TOP_DOWN}, maxElements{4},
          selectedIndex{0}, listMode{ListView::MODE_PAGE}, pageSize{4}
    {
        setPenFocusWidth(0);
        setPenWidth(0);

        scroll = new Rect(this,
                          style::listview::scroll_x,
                          style::listview::scroll_y,
                          style::listview::scroll_w,
                          style::listview::scroll_h);
        scroll->setRadius(style::listview::scroll_radius);
        scroll->setFilled(style::listview::scroll_fill);
        scroll->setFillColor(style::listview::scroll_color);
    }

    ListView::~ListView()
    {

        clearItems();
    }

    /**
     * For MODE_PAGE:
     * When new number of elements is provided list checks if currently visible items are still valid.
     * If value of the first index is invalid then new value is calculated using number of all elements
     * and defined size of page(number of visible elements).
     * Last index is calculated using value of first index and page size. If value is too big it is reduced
     * to index of the last element.
     * if index of selected element is invalid after change new value is set to the index of the last element
     * in the list.
     */
    void ListView::setElementsCount(int count)
    {
        elementsCount = count;
        if (listMode == ListView::MODE_PAGE) {
            if (firstIndex > elementsCount)
                firstIndex = (elementsCount / pageSize) * pageSize;
            lastIndex = firstIndex + pageSize - 1;
            if (lastIndex > elementsCount - 1)
                lastIndex = elementsCount - 1;
            if (selectedIndex > lastIndex)
                selectedIndex = lastIndex;
        }
        updateScrollDimenstions();
    }

    void ListView::setDrawSeparators(bool value)
    {
        drawSeparators = value;
    }

    void ListView::setOrientation(int orientation)
    {
        if (orientation == ListView::ORIENTATION_BOTTOM_UP)
            this->orientation = ListView::ORIENTATION_BOTTOM_UP;
        else if (orientation == ListView::ORIENTATION_TOP_DOWN)
            this->orientation = ListView::ORIENTATION_TOP_DOWN;
    }

    void ListView::drawScroll(bool value)
    {
        drawVerticalScroll = value;
        scroll->visible    = value;
    }

    void ListView::setMaxElements(int value)
    {
        maxElements = value;
    }

    void ListView::setProvider(ListItemProvider *provider)
    {
        this->provider = provider;
    }

    void ListView::clearItems()
    {

        for (auto item : items) {
            removeWidget(item);
            delete (item);
        }

        items.clear();
    }

    void ListView::clear()
    {
        clearItems();

        firstIndex    = 0;
        lastIndex     = 0;
        selectedIndex = 0;

        updateScrollDimenstions();
    }

    void ListView::updatePageItems()
    {

        int prevIndex = firstIndex - 1;
        for (int i = 0; i < pageSize; i++) {

            ListItem *item = provider->getItem(firstIndex + i, firstIndex, prevIndex, pageSize);
            if (item != nullptr) {
                addWidget(item);
                items.push_back(item);
                prevIndex++;
            }
        }

        // calculate item Width if scroll present
        uint32_t itemWidth = widgetArea.w;
        if (drawVerticalScroll)
            itemWidth -= style::listview::item_scroll_margin;

        // calculate height of the item using list's height and pageSize
        int availableHeight = widgetArea.h - pageSize;
        if (availableHeight < 0)
            availableHeight = 0;
        int itemHeight = availableHeight / pageSize;

        int verticalPosition;
        if (orientation == ORIENTATION_TOP_DOWN)
            verticalPosition = 0;
        else
            verticalPosition = widgetArea.h;

        auto it = items.begin();
        for (unsigned int i = 0; i < items.size(); i++) {
            if (availableHeight > 0) {

                itemHeight            = (*it)->minHeight;
                gui::BoundingBox bbox = (*it)->widgetArea;
                bbox.h                = itemHeight;
                bbox.w                = itemWidth;

                if (orientation == ORIENTATION_TOP_DOWN) {
                    bbox.y = verticalPosition;
                    verticalPosition += itemHeight + 1; // 1 for separator
                }
                else {
                    verticalPosition -= itemHeight - 1; // 1 for separator
                    bbox.y = verticalPosition;
                }

                (*it)->setBoundingBox(bbox);

                // if list has focus and it is visible mark selected element
                if (visible) {
                    if ((int)(i + firstIndex) == selectedIndex)
                        (*it)->setFocus(true);
                }

                availableHeight -= itemHeight;
            }
            std::advance(it, 1);
        }
    }

    bool ListView::onInput(const InputEvent &inputEvent)
    {

        if ((inputEvent.state == InputEvent::State::keyReleasedShort) && (inputEvent.keyCode == KeyCode::KEY_ENTER)) {
            return onActivated(nullptr);
        }

        if ((inputEvent.state == InputEvent::State::keyReleasedShort) && (inputEvent.keyCode == KeyCode::KEY_UP)) {
            if (orientation == ORIENTATION_TOP_DOWN) {
                if (listMode == MODE_PAGE) {
                    if (selectedIndex > firstIndex) {
                        selectedIndex--;
                        return true;
                    }
                    if (selectedIndex == firstIndex) {
                        if (firstIndex > 0) {
                            firstIndex -= pageSize;
                            if (firstIndex < 0)
                                firstIndex = 0;
                            lastIndex = firstIndex + pageSize - 1;
                            if (lastIndex > elementsCount - 1)
                                lastIndex = elementsCount - 1;
                            selectedIndex = lastIndex;
                            updateScrollDimenstions();
                            return true;
                        }
                    }
                }
                else {
                    // TODO implement continuous mode
                }
            }
            else if (orientation == ORIENTATION_BOTTOM_UP) {
                // TODO implement BOTTOM_UP orientation
            }
        }
        else if ((inputEvent.state == InputEvent::State::keyReleasedShort) &&
                 (inputEvent.keyCode == KeyCode::KEY_DOWN)) {
            if (orientation == ORIENTATION_TOP_DOWN) {
                if (listMode == MODE_PAGE) {
                    if (selectedIndex < lastIndex) {
                        selectedIndex++;
                        return true;
                    }
                    if (selectedIndex == lastIndex) {
                        if (lastIndex < elementsCount - 1) {
                            firstIndex += pageSize;
                            if (firstIndex > elementsCount - 1)
                                firstIndex = elementsCount - 1;
                            lastIndex = firstIndex + pageSize - 1;
                            if (lastIndex > elementsCount - 1)
                                lastIndex = elementsCount - 1;
                            selectedIndex = firstIndex;
                            updateScrollDimenstions();
                            return true;
                        }
                    }
                }
                else { // continuous mode
                }
            }
            else { // BOTTOM_UP
            }
        }
        return false;
    }

    void ListView::updateContinousItems()
    {}

    // TODO reuse items if possible
    void ListView::updateItems()
    {

        // remove old items
        clearItems();

        if (provider == nullptr)
            return;

        elementsCount = provider->getItemCount();

        if (listMode == ListView::MODE_PAGE) {
            updatePageItems();
        }
        else if (listMode == ListView::MODE_CONTINUOUS) {
            updateContinousItems();
        }
    }

    ListItem *ListView::getSelectedItem()
    {
        // return object only if there are any items in the list
        if (elementsCount) {
            auto it = items.begin();
            std::advance(it, selectedIndex - firstIndex);
            return *it;
        }
        return nullptr;
    }

    std::list<DrawCommand *> ListView::buildDrawList()
    {

        // check if widget is visible
        if (visible == false) {
            return std::list<DrawCommand *>();
        }

        updateItems();

        // uint8_t* bBuf = gui::Rect::buildDrawList(bSize, bCount);
        return gui::Rect::buildDrawList();
    }

    void ListView::setMode(int mode)
    {
        if ((mode == ListView::MODE_PAGE) || (mode == ListView::MODE_CONTINUOUS))
            listMode = mode;
    }

    void ListView::setPageSize(int size)
    {
        pageSize = size;
    }

    bool ListView::onActivated(void *data)
    {

        // return if list doesn't have focus
        if (focus == false)
            return false;

        // if there are any elements in the list
        if (elementsCount > 0) {
            // select item that has focus
            auto it = items.begin();
            std::advance(it, selectedIndex - firstIndex);
            return (*it)->onActivated(data);
        }

        return false;
    }

    bool ListView::onDimensionChanged(const BoundingBox &oldDim, const BoundingBox &newDim)
    {
        Rect::onDimensionChanged(oldDim, newDim);
        updateScrollDimenstions();
        return true;
    }

    void ListView::updateScrollDimenstions()
    {
        if ((widgetArea.w > 10) && (widgetArea.h > 10)) {
            if (drawVerticalScroll)
                scroll->visible = true;

            uint32_t pagesCount = 1;
            if (pageSize) {
                pagesCount = (elementsCount % pageSize == 0) ? elementsCount / pageSize : elementsCount / pageSize + 1;
                if (pagesCount == 0) {
                    disableScroll();
                    return;
                }
            }
            uint32_t currentPage = selectedIndex / pageSize;
            uint32_t pageHeight  = widgetArea.h / pagesCount;

            scroll->setPosition(widgetArea.w - style::listview::scroll_margin, pageHeight * currentPage);
            scroll->setSize(style::listview::scroll_w, pageHeight);
        }
        // not enough space - disable scroll
        else {
            disableScroll();
        }
    }

    void ListView::disableScroll()
    {
        scroll->setSize(0, 0);
        scroll->visible = false;
    }

} /* namespace gui */