PathStringGenerator.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) 2020  Jeff Jackowski
 */
#include <boost/exception/exception.hpp>
#include <boost/exception/info.hpp>
#include <exception>
#include <duds/ui/Path.hpp>

namespace duds { namespace ui {

struct PathStringGeneratorParameterError :
virtual std::exception, virtual boost::exception { };

typedef boost::error_info<struct Info_StringLength, std::string::size_type>
    StringLength;

typedef boost::error_info<struct Info_PathMaxLength, unsigned int>
    PathMaxLength;

typedef boost::error_info<struct Info_PathMaxTitleLength, unsigned int>
    PathMaxTitleLength;

typedef boost::error_info<struct Info_PathMinTitleLength, unsigned int>
    PathMinTitleLength;

class PathStringGenerator {
    std::string sep;
    std::string ellip;
    std::string preCur;
    std::string postCur;
    unsigned int maxLen = -1;
    unsigned int maxPages = -1;
    unsigned int maxPageLen = -1;
    unsigned int minPageLen = 4;
    bool showFwd = true;
    bool wholeCurrent = false;
    bool abruptSplit = false;
    std::string::size_type titleLength(
        const std::string &title,
        int &total,
        unsigned int max
    ) const;
    struct TrucatedTitle {
        const std::string *title;
        std::string::size_type len;
        TrucatedTitle() = default;
        TrucatedTitle(const std::string &t) :
            title(&t),
            len(t.size())
        { }
        TrucatedTitle(const std::string &t, std::string::size_type l) :
            title(&t),
            len(l)
        { }
    };
    void decTitleLen(const TrucatedTitle &tt, int &total) const;
    static int averageLength(int numtitles, int totalLen, int currLen);
public:
    PathStringGenerator() = default;
    PathStringGenerator(
        const std::string &separator,
        unsigned int mlen = -1
    ) : sep(separator), maxLen(mlen) { }
    PathStringGenerator(
        const std::string &separator,
        const std::string &ellipsis,
        unsigned int mlen = -1,
        unsigned int mtitle = -1
    );
    const std::string &separator() const {
        return sep;
    }
    void separator(const std::string &s) {
        sep = s;
    }
    const std::string &ellipsis() const {
        return ellip;
    }
    void ellipsis(const std::string &e);
    const std::string &currentHeader() const {
        return preCur;
    }
    void currentHeader(const std::string &h);
    const std::string &currentFooter() const {
        return postCur;
    }
    void currentFooter(const std::string &f);
    unsigned int maxLength() const {
        return maxLen;
    }
    void maxLength(unsigned int max);
    unsigned int maxTitles() const {
        return maxPages;
    }
    void maxTitles(unsigned int max) {
        maxPages = max;
    }
    unsigned int maxTitleLength() const {
        return maxPageLen;
    }
    void maxTitleLength(unsigned int max);
    unsigned int minTitleLength() const {
        return minPageLen;
    }
    void minTitleLength(unsigned int min);
    bool showForwardPage() const {
        return showFwd;
    }
    void showForwardPage(bool show = true) {
        showFwd = show;
    }
    bool showWholeCurrentPage() const {
        return wholeCurrent;
    }
    void showWholeCurrentPage(bool show = true) {
        wholeCurrent = show;
    }
    std::string generate(const Path &path) const;
};

} }