runner-options.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can be
 * obtained from https://opensource.org/licenses/mit.
 */
 
// ----------------------------------------------------------------------------

 
#ifndef MICRO_OS_PLUS_MICRO_TEST_PLUS_RUNNER_OPTIONS_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_RUNNER_OPTIONS_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if __has_include("micro-os-plus/project-config.h")
#include "micro-os-plus/project-config.h"
#endif // __has_include("micro-os-plus/project-config.h")
 
#if __has_include("micro-os-plus/micro-test-plus-defines.h")
#include "micro-os-plus/micro-test-plus-defines.h"
#endif // __has_include("micro-os-plus/micro-test-plus-defines.h")
 
#include <span>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#pragma GCC diagnostic ignored "-Wpadded"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------

  enum class verbosity
  {
    silent = 0, 
    quiet = 1, 
    normal = 2, 
    verbose = 3 
  };

  enum class reporter_kind
  {
    tap, 
    human 
  };

  enum class colour_mode
  {
    automatic, 
    always, 
    never 
  };
 
  // ==========================================================================

  class runner_options
  {
  public:
    runner_options (void) = default;

    explicit runner_options (int argc, char* argv[]);

    runner_options (const runner_options& other) = default;

    runner_options (runner_options&& other) = default;

    runner_options&
    operator= (const runner_options& other);

    runner_options&
    operator= (runner_options&& other)
        = default;

    ~runner_options () = default;

    reporter_kind selected_reporter{ reporter_kind::tap };

    micro_test_plus::verbosity verbosity_level{
      micro_test_plus::verbosity::normal
    };

    std::string output_file_path{};

    colour_mode colour{ colour_mode::automatic };

    std::vector<std::string> filter_patterns{};

    bool list_tests{ false };

    bool help{ false };

    [[nodiscard]] bool
    has_errors (void) const noexcept;

    [[nodiscard]] bool
    has_unknown_option (void) const noexcept;

    [[nodiscard]] const std::vector<std::string>&
    errors (void) const noexcept;

    [[nodiscard]] const std::vector<std::string>&
    arguments (void) const noexcept;

    [[nodiscard]] std::span<const std::string>
    application_arguments (void) const noexcept;
 
  private:
    void
    add_error (std::string_view before, std::string_view value = {},
               std::string_view after = {});

    std::vector<std::string> errors_{};

    bool unknown_option_{ false };

    std::vector<std::string> arguments_{};

    std::size_t application_begin_{ 0 };
  };
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
 
// ----------------------------------------------------------------------------
 
#endif // defined(__cplusplus)
 
// ============================================================================
// Templates, inlines & constexpr implementations.
 
#include "inlines/runner-options-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_RUNNER_OPTIONS_H_
 
// ----------------------------------------------------------------------------