Teuchos_SystemInformation.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_SYSTEMINFORMATION_HPP
#define TEUCHOS_SYSTEMINFORMATION_HPP


#include <map>
#include <string>

namespace Teuchos::SystemInformation {

bool commandIsAvailable(const std::string &command);

std::string runCommandAndCaptureOutput(const std::string &command);

enum RegistrationResult { REGISTERED, ALREADY_PRESENT, FAILURE };

RegistrationResult registerEnvironmentVariable(const std::string &variableName);

void registerAllPrefixedVariables(const std::string &prefix);

RegistrationResult
registerCommand(const std::string &commandLabel,
                const std::string &commandToRunAndCapture = "",
                const std::string &commandToCheckForExistence = "");

void initializeCollection();

std::map<std::string, std::string> collectSystemInformation();

} // namespace Teuchos::SystemInformation

#endif