DocumentBaseMarkup.h

// WARNING: Changes to this file must be contributed back to Sawyer or else they will
//          be clobbered by the next update from Sawyer.  The Sawyer repository is at
//          https://github.com/matzke1/sawyer.




#ifndef Sawyer_Document_BaseMarkup_H
#define Sawyer_Document_BaseMarkup_H

#include <Sawyer/DocumentMarkup.h>
#include <Sawyer/Sawyer.h>

namespace Sawyer {
namespace Document {

class SAWYER_EXPORT BaseMarkup: public Markup::Grammar {
    std::string pageName_;                              // name of document page, usually one word
    std::string chapterNumber_;                         // usually a number like "1", but not necessarily
    std::string chapterTitle_;                          // like "Command-line tools"
    std::string versionStr_;                            // version string
    std::string versionDate_;                           // date string

protected:
    BaseMarkup() {
        init();
    }

public:
    const std::string& pageName() const { return pageName_; }
    BaseMarkup& pageName(const std::string &s) { pageName_ = s; return *this; }
    const std::string& chapterNumber() const { return chapterNumber_; }
    BaseMarkup& chapterNumber(const std::string &s) { chapterNumber_ = s; return *this; }
    const std::string& chapterNumberOrDefault() const;
    const std::string& chapterTitle() const { return chapterTitle_; }
    BaseMarkup& chapterTitle(const std::string &s) { chapterTitle_ = s; return *this; }
    const std::string& chapterTitleOrDefault() const;
    const std::string& versionString() const { return versionStr_; }
    BaseMarkup& versionString(const std::string &s) { versionStr_ = s; return *this; }
    const std::string& versionStringOrDefault() const;
    const std::string& versionDate() const { return versionDate_; }
    BaseMarkup& versionDate(const std::string &s) { versionDate_ = s; return *this; }
    const std::string& versionDateOrDefault() const;
    BaseMarkup& title(const std::string &pageName, const std::string &chapterNumber, const std::string &chapterTitle);

    BaseMarkup& version(const std::string &versionString, const std::string &versionDate);

    virtual std::string operator()(const std::string&) /*override*/;

    virtual bool emit(const std::string &doc) = 0;

    static bool hasNonSpace(const std::string&);

    static std::string makeOneLine(const std::string&);

    static std::string leftJustify(const std::string&, size_t width);

    static std::string escapeSingleQuoted(const std::string&);

protected:
    // Last thing called before the rendered document is returend
    virtual std::string finalizeDocument(const std::string &s) { return s; }

private:
    void init();
};

} // namespace
} // namespace

#endif