xref: /freebsd/contrib/llvm-project/llvm/include/llvm/Support/PluginLoader.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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 #ifndef DONT_GET_PLUGIN_LOADER_OPTION
20 #include "llvm/Support/CommandLine.h"
21 #endif
22 
23 #include <string>
24 
25 namespace llvm {
26   struct PluginLoader {
27     void operator=(const std::string &Filename);
28     static unsigned getNumPlugins();
29     static std::string& getPlugin(unsigned num);
30   };
31 
32 #ifndef DONT_GET_PLUGIN_LOADER_OPTION
33   // This causes operator= above to be invoked for every -load option.
34   static cl::opt<PluginLoader, false, cl::parser<std::string>>
35       LoadOpt("load", cl::value_desc("pluginfilename"),
36               cl::desc("Load the specified plugin"));
37 #endif
38 }
39 
40 #endif
41