LLVM  10.0.0svn
WindowsManifestMerger.h
Go to the documentation of this file.
1 //===-- WindowsManifestMerger.h ---------------------------------*- C++-*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===---------------------------------------------------------------------===//
8 //
9 // This file provides a utility for merging Microsoft .manifest files. These
10 // files are xml documents which contain meta-information about applications,
11 // such as whether or not admin access is required, system compatibility,
12 // versions, etc. Part of the linking process of an executable may require
13 // merging several of these .manifest files using a tree-merge following
14 // specific rules. Unfortunately, these rules are not documented well
15 // anywhere. However, a careful investigation of the behavior of the original
16 // Microsoft Manifest Tool (mt.exe) revealed the rules of this merge. As the
17 // saying goes, code is the best documentation, so please look below if you are
18 // interested in the exact merging requirements.
19 //
20 // Ref:
21 // https://msdn.microsoft.com/en-us/library/windows/desktop/aa374191(v=vs.85).aspx
22 //
23 //===---------------------------------------------------------------------===//
24 
25 #ifndef LLVM_INCLUDE_LLVM_SUPPORT_WINDOWS_MANIFEST_MERGER_H
26 #define LLVM_INCLUDE_LLVM_SUPPORT_WINDOWS_MANIFEST_MERGER_H
27 
28 #include "llvm/Support/Error.h"
29 
30 namespace llvm {
31 
32 class MemoryBuffer;
33 
34 namespace windows_manifest {
35 
36 bool isAvailable();
37 
38 class WindowsManifestError : public ErrorInfo<WindowsManifestError, ECError> {
39 public:
40  static char ID;
41  WindowsManifestError(const Twine &Msg);
42  void log(raw_ostream &OS) const override;
43 
44 private:
45  std::string Msg;
46 };
47 
49 public:
52  Error merge(const MemoryBuffer &Manifest);
53 
54  // Returns vector containing merged xml manifest, or uninitialized vector for
55  // empty manifest.
56  std::unique_ptr<MemoryBuffer> getMergedManifest();
57 
58 private:
60  std::unique_ptr<WindowsManifestMergerImpl> Impl;
61 };
62 
63 } // namespace windows_manifest
64 } // namespace llvm
65 #endif
This class represents lattice values for constants.
Definition: AllocatorList.h:23
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
void log(raw_ostream &OS) const override
Print an error message to an output stream.
This interface provides simple read-only access to a block of memory, and provides simple methods for...
Definition: MemoryBuffer.h:41
Base class for user error types.
Definition: Error.h:344
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45