Path.hpp

Go to the documentation of this file.

/*
 * This file is part of the DUDS project. It is subject to the BSD-style
 * license terms in the LICENSE file found in the top-level directory of this
 * distribution and at https://github.com/jjackowski/duds/blob/master/LICENSE.
 * No part of DUDS, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 *
 * Copyright (C) 2019  Jeff Jackowski
 */
#ifndef PATH_HPP
#define PATH_HPP

#include <duds/ui/Page.hpp>
#include <vector>

namespace duds { namespace ui {

class Path {
public:
    typedef std::vector<PageSptr>  PageStack;
private:
    PageStack pages;
    int spot;
public:
    Path() : spot(-1) { };
    Path(const PageSptr &first);
    void push(const PageSptr &page);
    void push(PageSptr &&page);
    bool move(int steps);
    bool back() {
        return move(-1);
    }
    bool forward() {
        return move(1);
    }
    bool atStart() const {
        return spot == 0;
    }
    bool atEnd() const {
        return !pages.empty() && (spot == pages.size() - 1);
    }
    void clear();
    void clearPastCurrent();
    bool empty() const {
        return pages.empty();
    }
    PageStack::size_type size() const {
        return pages.size();
    }
    const PageSptr &currentPage() const {
        return pages.at(spot);
    }
    PageStack::const_iterator begin() const {
        return pages.cbegin();
    }
    PageStack::const_reverse_iterator rbegin() const {
        return pages.crbegin();
    }
    PageStack::const_iterator end() const {
        return pages.cend();
    }
    PageStack::const_reverse_iterator rend() const {
        return pages.crend();
    }
    PageStack::const_iterator current() const {
        return pages.cbegin() + spot;
    }
    PageStack::const_reverse_iterator rcurrent() const {
        return pages.crend() - spot - 1;
    }
};

} }

#endif        //  #ifndef PATH_HPP