diff options
Diffstat (limited to 'share/doc/gccint/Plugins-loading.html')
-rw-r--r-- | share/doc/gccint/Plugins-loading.html | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/share/doc/gccint/Plugins-loading.html b/share/doc/gccint/Plugins-loading.html new file mode 100644 index 0000000..5626212 --- /dev/null +++ b/share/doc/gccint/Plugins-loading.html @@ -0,0 +1,106 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 1988-2023 Free Software Foundation, Inc. + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with the +Invariant Sections being "Funding Free Software", the Front-Cover +Texts being (a) (see below), and with the Back-Cover Texts being (b) +(see below). A copy of the license is included in the section entitled +"GNU Free Documentation License". + +(a) The FSF's Front-Cover Text is: + +A GNU Manual + +(b) The FSF's Back-Cover Text is: + +You have freedom to copy and modify this GNU Manual, like GNU + software. Copies published by the Free Software Foundation raise + funds for GNU development. --> +<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ --> +<head> +<title>GNU Compiler Collection (GCC) Internals: Plugins loading</title> + +<meta name="description" content="GNU Compiler Collection (GCC) Internals: Plugins loading"> +<meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Plugins loading"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<link href="index.html#Top" rel="start" title="Top"> +<link href="Option-Index.html#Option-Index" rel="index" title="Option Index"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Plugins.html#Plugins" rel="up" title="Plugins"> +<link href="Plugin-API.html#Plugin-API" rel="next" title="Plugin API"> +<link href="Plugins.html#Plugins" rel="previous" title="Plugins"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.indentedblock {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smallindentedblock {margin-left: 3.2em; font-size: smaller} +div.smalllisp {margin-left: 3.2em} +kbd {font-style:oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: inherit; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: inherit; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.nocodebreak {white-space:nowrap} +span.nolinebreak {white-space:nowrap} +span.roman {font-family:serif; font-weight:normal} +span.sansserif {font-family:sans-serif; font-weight:normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> +<a name="Plugins-loading"></a> +<div class="header"> +<p> +Next: <a href="Plugin-API.html#Plugin-API" accesskey="n" rel="next">Plugin API</a>, Up: <a href="Plugins.html#Plugins" accesskey="u" rel="up">Plugins</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p> +</div> +<hr> +<a name="Loading-Plugins"></a> +<h3 class="section">24.1 Loading Plugins</h3> + +<p>Plugins are supported on platforms that support <samp>-ldl +-rdynamic</samp> as well as Windows/MinGW. They are loaded by the compiler +using <code>dlopen</code> or equivalent and invoked at pre-determined +locations in the compilation process. +</p> +<p>Plugins are loaded with +</p> +<p><samp>-fplugin=/path/to/<var>name</var>.<var>ext</var></samp> <samp>-fplugin-arg-<var>name</var>-<var>key1</var>[=<var>value1</var>]</samp> +</p> +<p>Where <var>name</var> is the plugin name and <var>ext</var> is the platform-specific +dynamic library extension. It should be <code>dll</code> on Windows/MinGW, +<code>dylib</code> on Darwin/Mac OS X, and <code>so</code> on all other platforms. +The plugin arguments are parsed by GCC and passed to respective +plugins as key-value pairs. Multiple plugins can be invoked by +specifying multiple <samp>-fplugin</samp> arguments. +</p> +<p>A plugin can be simply given by its short name (no dots or +slashes). When simply passing <samp>-fplugin=<var>name</var></samp>, the plugin is +loaded from the <samp>plugin</samp> directory, so <samp>-fplugin=<var>name</var></samp> is +the same as <samp>-fplugin=`gcc -print-file-name=plugin`/<var>name</var>.<var>ext</var></samp>, +using backquote shell syntax to query the <samp>plugin</samp> directory. +</p> + + + +</body> +</html> |