Source/CTest/cmCTestLaunch.h

/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file LICENSE.rst or https://cmake.org/licensing for details.  */
#pragma once

#include "cmConfigure.h" // IWYU pragma: keep

#include <string>
#include <vector>

#include <cm/optional>

#include <cmsys/SystemInformation.hxx>

#include "cmCTestLaunchReporter.h"

namespace cmsys {
class RegularExpression;
}

/** \class cmCTestLaunch
 * \brief Launcher for make rules to report results for ctest
 *
 * This implements the 'ctest --launch' tool.
 */
class cmCTestLaunch
{

public:
  enum class Op
  {
    Normal,
    Instrument,
    InstrumentTest,
  };

  /** Entry point from ctest executable main().  */
  static int Main(int argc, char const* const argv[], Op operation);

  cmCTestLaunch(cmCTestLaunch const&) = delete;
  cmCTestLaunch& operator=(cmCTestLaunch const&) = delete;

private:
  // Initialize the launcher from its command line.
  cmCTestLaunch(int argc, char const* const* argv, Op operation);
  ~cmCTestLaunch();

  // Run the real command.
  int Run();
  void RunChild();

  // Method to check the result of the real command.
  bool CheckResults();

  // Parse out launcher-specific options specified before the real command.
  bool ParseArguments(int argc, char const* const* argv);

  // The real command line appearing after launcher arguments.
  std::vector<std::string> RealArgV;

  // The real command line after response file expansion.
  std::vector<std::string> RealArgs;
  void HandleRealArg(char const* arg);
  std::string MetricsFile;

  cm::optional<cmsys::SystemInformation::ProcessResourceUsage>
    ChildResourceUsage;
  void WriteMetricsFile() const;

  // Whether or not any data have been written to stdout or stderr.
  bool HaveOut;
  bool HaveErr;
  std::string CapturedStdOut;
  std::string CapturedStdErr;

  // Load custom rules to match warnings and their exceptions.
  bool ScrapeRulesLoaded;
  void LoadScrapeRules();
  void LoadScrapeRules(char const* purpose,
                       std::vector<cmsys::RegularExpression>& regexps) const;
  bool ScrapeLog(std::string const& fname);

  // Helper class to generate the xml fragment.
  cmCTestLaunchReporter Reporter;

  // Configuration
  void LoadConfig();

  // Mode
  Op Operation;
};