Linker.h revision 256281 
1//===- llvm/Linker.h - Module Linker Interface ------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef LLVM_LINKER_H
11#define LLVM_LINKER_H
12
13#include "llvm/ADT/SmallPtrSet.h"
14#include <string>
15
16namespace llvm {
17
18class Module;
19class StringRef;
20class StructType;
21
22/// This class provides the core functionality of linking in LLVM. It keeps a
23/// pointer to the merged module so far. It doesn't take ownership of the
24/// module since it is assumed that the user of this class will want to do
25/// something with it after the linking.
26class Linker {
27  public:
28    enum LinkerMode {
29      DestroySource = 0, // Allow source module to be destroyed.
30      PreserveSource = 1 // Preserve the source module.
31    };
32
33    Linker(Module *M);
34    ~Linker();
35    Module *getModule() const { return Composite; }
36
37    /// \brief Link \p Src into the composite. The source is destroyed if
38    /// \p Mode is DestroySource and preserved if it is PreserveSource.
39    /// If \p ErrorMsg is not null, information about any error is written
40    /// to it.
41    /// Returns true on error.
42    bool linkInModule(Module *Src, unsigned Mode, std::string *ErrorMsg);
43    bool linkInModule(Module *Src, std::string *ErrorMsg) {
44      return linkInModule(Src, Linker::DestroySource, ErrorMsg);
45    }
46
47    static bool LinkModules(Module *Dest, Module *Src, unsigned Mode,
48                            std::string *ErrorMsg);
49
50  private:
51    Module *Composite;
52    SmallPtrSet<StructType*, 32> IdentifiedStructTypes;
53};
54
55} // End llvm namespace
56
57#endif
58