Path.h

Go to the documentation of this file.

//===- Path.h - Path Utilities ----------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Utilities for file system path handling, supplementing the ones from
// llvm::sys::path.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_SUPPORT_PATH_H
#define CIRCT_SUPPORT_PATH_H
 
#include "circt/Support/LLVM.h"
#include "llvm/Support/ToolOutputFile.h"
 
namespace circt {
 
/// Append a path to an existing path, replacing it if the other path is
/// absolute. This mimicks the behaviour of `foo/bar` and `/foo/bar` being used
/// in a working directory `/home`, resulting in `/home/foo/bar` and `/foo/bar`,
/// respectively.
void appendPossiblyAbsolutePath(llvm::SmallVectorImpl<char> &base,
                                const llvm::Twine &suffix);
 
/// Truncate `a` in place to the longest common directory prefix of `a` and `b`,
/// ensuring that the result ends on a directory separator (or is empty). This
/// computes the lowest common ancestor directory of two paths and is used, for
/// example, to pick a shared output directory for deduplicated operations.
void makeCommonDirectoryPrefix(llvm::SmallVectorImpl<char> &a, StringRef b);
 
/// Creates an output file with the given filename in the specified directory.
/// The function will create any parent directories as needed. If an error
/// occurs during file or directory creation, it will use the provided emitError
/// callback to report the error and return an empty unique_ptr.
std::unique_ptr<llvm::ToolOutputFile>
createOutputFile(StringRef filename, StringRef dirname,
                 function_ref<InFlightDiagnostic()> emitError);
 
} // namespace circt
 
#endif // CIRCT_SUPPORT_PATH_H