Capabilities.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "CapabilityRegistry.h"

#include "nlohmann/json_fwd.h"

#ifdef MOOSE_UNIT_TEST
// forward declare unit tests
#include "gtest/gtest.h"
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, augment);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, augmentParseError);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, check);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, dump);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, isInstallationType);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, mooseAppCheckCapabilities);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, mooseAppCheckRequiredCapabilities);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, mooseAppIsRelocated);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, mooseAppisInTree);
class GTEST_TEST_CLASS_NAME_(RegistryTest, addDataFilePath);
class GTEST_TEST_CLASS_NAME_(RegistryTest, addMissingDataFilePath);
class CapabilitiesTest;
class DataFileUtilsTest;
class RegistryTest;
#endif

class AppFactory;
class Registry;
class MooseApp;

namespace Moose::internal
{

class Capabilities : public CapabilityRegistry
{
public:
  class GetCapabilitiesPassKey
  {
    friend AppFactory;
    friend MooseApp;
    friend Registry;
#ifdef MOOSE_UNIT_TEST
    friend class ::CapabilitiesTest;
    friend class ::DataFileUtilsTest;
    friend class ::RegistryTest;
    FRIEND_TEST(::CapabilitiesTest, augment);
    FRIEND_TEST(::CapabilitiesTest, augmentParseError);
    FRIEND_TEST(::CapabilitiesTest, check);
    FRIEND_TEST(::CapabilitiesTest, dump);
    FRIEND_TEST(::CapabilitiesTest, isInstallationType);
    FRIEND_TEST(::CapabilitiesTest, mooseAppCheckCapabilities);
    FRIEND_TEST(::CapabilitiesTest, mooseAppCheckRequiredCapabilities);
    FRIEND_TEST(::RegistryTest, addDataFilePath);
    FRIEND_TEST(::RegistryTest, addMissingDataFilePath);
#endif
    GetCapabilitiesPassKey() {}
    GetCapabilitiesPassKey(const GetCapabilitiesPassKey &) {}
  };

  static Capabilities & getCapabilities(const GetCapabilitiesPassKey);

  std::string dump() const;

  class AugmentPassKey
  {
    friend MooseApp;
#ifdef MOOSE_UNIT_TEST
    FRIEND_TEST(::CapabilitiesTest, augment);
    FRIEND_TEST(::CapabilitiesTest, augmentParseError);
#endif
    AugmentPassKey() {}
    AugmentPassKey(const AugmentPassKey &) {}
  };

  void augment(const nlohmann::json & input, const AugmentPassKey);

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

  Capabilities(Capabilities &&) = delete;
  Capabilities & operator=(Capabilities &&) = delete;

  bool isRelocated() const { return isInstallationType("relocated"); }

  bool isInTree() const { return isInstallationType("in_tree"); }

private:
#ifdef MOOSE_UNIT_TEST
  friend class ::CapabilitiesTest;
  friend class ::DataFileUtilsTest;
  friend class ::RegistryTest;
  FRIEND_TEST(::CapabilitiesTest, isInstallationType);
  FRIEND_TEST(::CapabilitiesTest, mooseAppIsRelocated);
  FRIEND_TEST(::CapabilitiesTest, mooseAppisInTree);
#endif

  bool isInstallationType(const std::string & installation_type) const;

  void registerMooseCapabilities();

  // Private constructor for singleton pattern
  Capabilities();
};

} // namespace Moose::internal