help_printer_iface.hpp

Go to the documentation of this file.

 
/*
    SPDX-FileCopyrightText: 2026 Igor Mironchik <igor.mironchik@gmail.com>
    SPDX-License-Identifier: MIT
*/
 
#ifndef ARGS__HELP_PRINTER_IFACE_HPP__INCLUDED
#define ARGS__HELP_PRINTER_IFACE_HPP__INCLUDED
 
// Args include.
#include "utils.hpp"
 
namespace Args
{
 
class CmdLine;
class Command;
class ArgIface;
 
//
// HelpPrinterIface
//

class HelpPrinterIface
{
public:
    HelpPrinterIface()
    {
    }
 
    virtual ~HelpPrinterIface()
    {
    }

    virtual void print(
        OutStreamType &to) = 0;

    virtual void print(
        const String &name,
        OutStreamType &to,
        Command *parent = nullptr) = 0;

    virtual void setExecutable(const String &exe) = 0;

    virtual void setAppDescription(const String &desc) = 0;

    virtual void setCmdLine(CmdLine *cmd) = 0;

    virtual void setLineLength(String::size_type length) = 0;

    virtual ArgIface *findArgument(const String &name) = 0;
 
private:
    DISABLE_COPY(HelpPrinterIface)
}; // class HelpPrinterIface
 
} /* namespace Args */
 
#endif // ARGS__HELP_PRINTER_IFACE_HPP__INCLUDED