DataFileUtils.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 <string>
#include <optional>

namespace Moose::DataFileUtils
{

enum class Context
{
  RELATIVE,
  ABSOLUTE,
  DATA,
  RELATIVE_NOT_FOUND,
  ABSOLUTE_NOT_FOUND,
  INVALID
};

struct Path
{
  Path() : path(), context(Context::INVALID), data_name() {}
  Path(const std::string & path,
       const Context context,
       const std::optional<std::string> & data_name = std::optional<std::string>())
    : path(path), context(context), data_name(data_name)
  {
  }
  // Path to the file
  std::string path;
  Context context;
  std::optional<std::string> data_name;
};

struct GetPathOptions
{
  std::optional<std::string> base;
  bool search_all_data = true;
  bool graceful = false;
};

Path getPath(std::string path, const GetPathOptions & options = {});

Path getPathExplicit(const std::string & data_name,
                     const std::string & path,
                     const std::optional<std::string> & base = std::optional<std::string>());
}