xref: /freebsd/contrib/llvm-project/llvm/include/llvm/Support/PluginLoader.h (revision 4996ebdb720042239a197ebec2d265cdfdf1bbf3)
1 //===-- llvm/Support/PluginLoader.h - Plugin Loader for Tools ---*- 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 // A tool can #include this file to get a -load option that allows the user to
10 // load arbitrary shared objects into the tool's address space.  Note that this
11 // header can only be included by a program ONCE, so it should never to used by
12 // library authors.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_SUPPORT_PLUGINLOADER_H
17 #define LLVM_SUPPORT_PLUGINLOADER_H
18 
19 #include "llvm/Support/Compiler.h"
20 
21 #ifndef DONT_GET_PLUGIN_LOADER_OPTION
22 #include "llvm/Support/CommandLine.h"
23 #endif
24 
25 #include <string>
26 
27 namespace llvm {
28   struct PluginLoader {
29     LLVM_ABI void operator=(const std::string &Filename);
30     LLVM_ABI static unsigned getNumPlugins();
31     LLVM_ABI static std::string &getPlugin(unsigned num);
32   };
33 
34 #ifndef DONT_GET_PLUGIN_LOADER_OPTION
35   // This causes operator= above to be invoked for every -load option.
36   static cl::opt<PluginLoader, false, cl::parser<std::string>>
37       LoadOpt("load", cl::value_desc("pluginfilename"),
38               cl::desc("Load the specified plugin"));
39 #endif
40 }
41 
42 #endif
43