docwriting.h

/*
 * Copyright 2025 Dominik Czekai
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
#include <memory>
 
#include "cli_config.h"
#include "commands/argument.h"
#include "commands/argument_group.h"
#include "commands/command.h"
#include "commands/docwriting/docformatter.h"
#include "commands/flag_argument.h"
#include "commands/option_argument.h"
#include "commands/positional_argument.h"
 
namespace cli::commands::docwriting
{
 
class DocWriter
{
 
public:
    explicit DocWriter(const CliConfig &config) : configuration(config) {}
 
    void setAppFormatter(std::unique_ptr<AbstractCliAppDocFormatter> formatter);
 
    void setOptionFormatter(std::unique_ptr<AbstractArgDocFormatter<OptionArgumentBase>> formatter);
 
    void setPositionalFormatter(
        std::unique_ptr<AbstractArgDocFormatter<PositionalArgumentBase>> formatter);
 
    void setFlagFormatter(std::unique_ptr<AbstractArgDocFormatter<FlagArgument>> formatter);
 
    void setCommandFormatter(std::unique_ptr<AbstractCommandFormatter> formatter);
 
    void setDocStrings(Command &command, std::string_view fullCommandPath) const;
 
    std::string generateLongDocString(const Command &command,
                                      std::string_view fullCommandPath) const;
 
    std::string generateShortDocString(const Command &command,
                                       std::string_view fullCommandPath) const;
 
    std::string generateOptionsDocString(const FlagArgument &argument) const;
 
    std::string generateArgDocString(const FlagArgument &argument) const;
 
    std::string generateOptionsDocString(const OptionArgumentBase &argument) const;
 
    std::string generateArgDocString(const OptionArgumentBase &argument) const;
 
    std::string generateOptionsDocString(const PositionalArgumentBase &argument) const;
 
    std::string generateArgDocString(const PositionalArgumentBase &argument) const;
 
    std::string generateAppDocString(const std::vector<const cli::commands::Command *> &commands) const;
 
    std::string generateCommandDocString(const Command &command) const;
 
    std::string generateAppVersionString() const;
 
private:
    const CliConfig &configuration;
 
    std::unique_ptr<AbstractCommandFormatter> commandFormatterPtr =
        std::make_unique<DefaultCommandFormatter>();
    std::unique_ptr<AbstractArgDocFormatter<FlagArgument>> flagFormatterPtr =
        std::make_unique<DefaultFlagFormatter>();
    std::unique_ptr<AbstractArgDocFormatter<OptionArgumentBase>> optionFormatterPtr =
        std::make_unique<DefaultOptionFormatter>();
    std::unique_ptr<AbstractArgDocFormatter<PositionalArgumentBase>> positionalFormatterPtr =
        std::make_unique<DefaultPositionalFormatter>();
    std::unique_ptr<AbstractCliAppDocFormatter> appFormatterPtr = std::make_unique<DefaultCliAppDocFormatter>();
};
 
} // namespace cli::commands::docwriting