Initial dsymutil tool commit.
[oota-llvm.git] / tools / dsymutil / dsymutil.h
1 //===- tools/dsymutil/dsymutil.h - dsymutil high-level functionality ------===//
2 //
3 //                             The LLVM Linker
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 ///
12 /// This file contains the class declaration for the code that parses STABS
13 /// debug maps that are embedded in the binaries symbol tables.
14 ///
15 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_TOOLS_DSYMUTIL_DSYMUTIL_H
17 #define LLVM_TOOLS_DSYMUTIL_DSYMUTIL_H
18
19 #include "DebugMap.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/Support/ErrorOr.h"
22 #include <memory>
23
24 namespace llvm {
25 namespace dsymutil {
26 /// \brief Extract the DebugMap from the given file.
27 /// The file has to be a MachO object file.
28 llvm::ErrorOr<std::unique_ptr<DebugMap>>
29 parseDebugMap(StringRef InputFile, StringRef PrependPath = "");
30
31 /// \brief Link the Dwarf debuginfo as directed by the passed DebugMap
32 /// \p DM into a DwarfFile named \p OutputFilename.
33 /// \returns false if the link failed.
34 bool linkDwarf(StringRef OutputFilename, const DebugMap &DM);
35 }
36 }
37 #endif // LLVM_TOOLS_DSYMUTIL_DSYMUTIL_H