| <!DOCTYPE HTML> | |
| <html lang="en" class="sidebar-visible no-js light"> | |
| <head> | |
| <!-- Book generated using mdBook --> | |
| <meta charset="UTF-8"> | |
| <title>Finding Libraries with pkg-config - The bindgen User Guide</title> | |
| <!-- Custom HTML head --> | |
| <meta name="description" content="`bindgen` automatically generates Rust FFI bindings to C and C++ libraries."> | |
| <meta name="viewport" content="width=device-width, initial-scale=1"> | |
| <meta name="theme-color" content="#ffffff" /> | |
| <link rel="icon" href="favicon.svg"> | |
| <link rel="shortcut icon" href="favicon.png"> | |
| <link rel="stylesheet" href="css/variables.css"> | |
| <link rel="stylesheet" href="css/general.css"> | |
| <link rel="stylesheet" href="css/chrome.css"> | |
| <link rel="stylesheet" href="css/print.css" media="print"> | |
| <!-- Fonts --> | |
| <link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> | |
| <link rel="stylesheet" href="fonts/fonts.css"> | |
| <!-- Highlight.js Stylesheets --> | |
| <link rel="stylesheet" href="highlight.css"> | |
| <link rel="stylesheet" href="tomorrow-night.css"> | |
| <link rel="stylesheet" href="ayu-highlight.css"> | |
| <!-- Custom theme stylesheets --> | |
| </head> | |
| <body> | |
| <div id="body-container"> | |
| <!-- Provide site root to javascript --> | |
| <script> | |
| var path_to_root = ""; | |
| var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; | |
| </script> | |
| <!-- Work around some values being stored in localStorage wrapped in quotes --> | |
| <script> | |
| try { | |
| var theme = localStorage.getItem('mdbook-theme'); | |
| var sidebar = localStorage.getItem('mdbook-sidebar'); | |
| if (theme.startsWith('"') && theme.endsWith('"')) { | |
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); | |
| } | |
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { | |
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); | |
| } | |
| } catch (e) { } | |
| </script> | |
| <!-- Set the theme before any content is loaded, prevents flash --> | |
| <script> | |
| var theme; | |
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } | |
| if (theme === null || theme === undefined) { theme = default_theme; } | |
| var html = document.querySelector('html'); | |
| html.classList.remove('no-js') | |
| html.classList.remove('light') | |
| html.classList.add(theme); | |
| html.classList.add('js'); | |
| </script> | |
| <!-- Hide / unhide sidebar before it is displayed --> | |
| <script> | |
| var html = document.querySelector('html'); | |
| var sidebar = null; | |
| if (document.body.clientWidth >= 1080) { | |
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } | |
| sidebar = sidebar || 'visible'; | |
| } else { | |
| sidebar = 'hidden'; | |
| } | |
| html.classList.remove('sidebar-visible'); | |
| html.classList.add("sidebar-" + sidebar); | |
| </script> | |
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> | |
| <div class="sidebar-scrollbox"> | |
| <ol class="chapter"><li class="chapter-item expanded "><a href="introduction.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="requirements.html"><strong aria-hidden="true">2.</strong> Requirements</a></li><li class="chapter-item expanded "><a href="library-usage.html"><strong aria-hidden="true">3.</strong> Library Usage with build.rs</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="tutorial-0.html"><strong aria-hidden="true">3.1.</strong> Tutorial</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="tutorial-1.html"><strong aria-hidden="true">3.1.1.</strong> Add bindgen as a Build Dependency</a></li><li class="chapter-item expanded "><a href="tutorial-2.html"><strong aria-hidden="true">3.1.2.</strong> Create a wrapper.h Header</a></li><li class="chapter-item expanded "><a href="tutorial-3.html"><strong aria-hidden="true">3.1.3.</strong> Create a build.rs File</a></li><li class="chapter-item expanded "><a href="tutorial-4.html"><strong aria-hidden="true">3.1.4.</strong> Include the Generated Bindings in src/lib.rs</a></li><li class="chapter-item expanded "><a href="tutorial-5.html"><strong aria-hidden="true">3.1.5.</strong> Write a Smoke Test</a></li><li class="chapter-item expanded "><a href="tutorial-6.html"><strong aria-hidden="true">3.1.6.</strong> Publish Your Crate!</a></li></ol></li><li class="chapter-item expanded "><a href="non-system-libraries.html"><strong aria-hidden="true">3.2.</strong> Bindings for Non-System Libraries</a></li><li class="chapter-item expanded "><a href="pkg-config.html" class="active"><strong aria-hidden="true">3.3.</strong> Finding Libraries with pkg-config</a></li></ol></li><li class="chapter-item expanded "><a href="command-line-usage.html"><strong aria-hidden="true">4.</strong> Command Line Usage</a></li><li class="chapter-item expanded "><a href="customizing-generated-bindings.html"><strong aria-hidden="true">5.</strong> Customizing the Generated Bindings</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="allowlisting.html"><strong aria-hidden="true">5.1.</strong> Allowlisting</a></li><li class="chapter-item expanded "><a href="blocklisting.html"><strong aria-hidden="true">5.2.</strong> Blocklisting</a></li><li class="chapter-item expanded "><a href="opaque.html"><strong aria-hidden="true">5.3.</strong> Treating a Type as an Opaque Blob of Bytes</a></li><li class="chapter-item expanded "><a href="replacing-types.html"><strong aria-hidden="true">5.4.</strong> Replacing One Type with Another</a></li><li class="chapter-item expanded "><a href="nocopy.html"><strong aria-hidden="true">5.5.</strong> Preventing the Derivation of Copy and Clone</a></li><li class="chapter-item expanded "><a href="nodebug.html"><strong aria-hidden="true">5.6.</strong> Preventing the Derivation of Debug</a></li><li class="chapter-item expanded "><a href="nodefault.html"><strong aria-hidden="true">5.7.</strong> Preventing the Derivation of Default</a></li><li class="chapter-item expanded "><a href="must-use-types.html"><strong aria-hidden="true">5.8.</strong> Annotating Types with #[must-use]</a></li><li class="chapter-item expanded "><a href="visibility.html"><strong aria-hidden="true">5.9.</strong> Field Visibility</a></li><li class="chapter-item expanded "><a href="code-formatting.html"><strong aria-hidden="true">5.10.</strong> Code Formatting</a></li></ol></li><li class="chapter-item expanded "><a href="cpp.html"><strong aria-hidden="true">6.</strong> Generating Bindings to C++</a></li><li class="chapter-item expanded "><a href="objc.html"><strong aria-hidden="true">7.</strong> Generating Bindings to Objective-C</a></li><li class="chapter-item expanded "><a href="using-unions.html"><strong aria-hidden="true">8.</strong> Using Unions</a></li><li class="chapter-item expanded "><a href="using-bitfields.html"><strong aria-hidden="true">9.</strong> Using Bitfields</a></li><li class="chapter-item expanded "><a href="using-fam.html"><strong aria-hidden="true">10.</strong> Using Flexible Array Members</a></li><li class="chapter-item expanded "><a href="faq.html"><strong aria-hidden="true">11.</strong> FAQ</a></li></ol> | |
| </div> | |
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> | |
| </nav> | |
| <!-- Track and set sidebar scroll position --> | |
| <script> | |
| var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); | |
| sidebarScrollbox.addEventListener('click', function(e) { | |
| if (e.target.tagName === 'A') { | |
| sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); | |
| } | |
| }, { passive: true }); | |
| var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); | |
| sessionStorage.removeItem('sidebar-scroll'); | |
| if (sidebarScrollTop) { | |
| // preserve sidebar scroll position when navigating via links within sidebar | |
| sidebarScrollbox.scrollTop = sidebarScrollTop; | |
| } else { | |
| // scroll sidebar to current active section when navigating via "next/previous chapter" buttons | |
| var activeSection = document.querySelector('#sidebar .active'); | |
| if (activeSection) { | |
| activeSection.scrollIntoView({ block: 'center' }); | |
| } | |
| } | |
| </script> | |
| <div id="page-wrapper" class="page-wrapper"> | |
| <div class="page"> | |
| <div id="menu-bar-hover-placeholder"></div> | |
| <div id="menu-bar" class="menu-bar sticky"> | |
| <div class="left-buttons"> | |
| <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> | |
| <i class="fa fa-bars"></i> | |
| </button> | |
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> | |
| <i class="fa fa-paint-brush"></i> | |
| </button> | |
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> | |
| <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> | |
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> | |
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> | |
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> | |
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> | |
| </ul> | |
| <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> | |
| <i class="fa fa-search"></i> | |
| </button> | |
| </div> | |
| <h1 class="menu-title">The bindgen User Guide</h1> | |
| <div class="right-buttons"> | |
| <a href="print.html" title="Print this book" aria-label="Print this book"> | |
| <i id="print-button" class="fa fa-print"></i> | |
| </a> | |
| <a href="https://github.com/rust-lang/rust-bindgen" title="Git repository" aria-label="Git repository"> | |
| <i id="git-repository-button" class="fa fa-github"></i> | |
| </a> | |
| <a href="https://github.com/rust-lang/rust-bindgen/edit/main/book/src/pkg-config.md" title="Suggest an edit" aria-label="Suggest an edit"> | |
| <i id="git-edit-button" class="fa fa-edit"></i> | |
| </a> | |
| </div> | |
| </div> | |
| <div id="search-wrapper" class="hidden"> | |
| <form id="searchbar-outer" class="searchbar-outer"> | |
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> | |
| </form> | |
| <div id="searchresults-outer" class="searchresults-outer hidden"> | |
| <div id="searchresults-header" class="searchresults-header"></div> | |
| <ul id="searchresults"> | |
| </ul> | |
| </div> | |
| </div> | |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> | |
| <script> | |
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); | |
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); | |
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { | |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); | |
| }); | |
| </script> | |
| <div id="content" class="content"> | |
| <main> | |
| <h1 id="finding-libraries-with-pkg-config"><a class="header" href="#finding-libraries-with-pkg-config">Finding Libraries with <code>pkg-config</code></a></h1> | |
| <p>Many C libraries install their headers somewhere that <code>clang</code> does not search | |
| by default. Some keep them in a versioned subdirectory such as | |
| <code>/usr/include/libpng16</code>, and package managers like Homebrew install them under | |
| their own prefix. In that case <code>bindgen</code> fails with an error like | |
| <code>fatal error: 'png.h' file not found</code>.</p> | |
| <p>Such libraries usually ship a <a href="https://www.freedesktop.org/wiki/Software/pkg-config/"><code>pkg-config</code></a> file describing where | |
| their headers and binaries live. The <a href="https://docs.rs/pkg-config"><code>pkg-config</code> crate</a> can | |
| query it from <code>build.rs</code>, and we can pass the include paths it finds to | |
| <code>bindgen</code>.</p> | |
| <p>First, add <code>pkg-config</code> to the <code>[build-dependencies]</code> section next to <code>bindgen</code>:</p> | |
| <pre><code class="language-toml">[build-dependencies] | |
| bindgen = "0.73.2" | |
| pkg-config = "0.3" | |
| </code></pre> | |
| <p>Our <code>wrapper.h</code> includes the library's header as usual:</p> | |
| <pre><code class="language-c">#include <png.h> | |
| </code></pre> | |
| <p>Then, in <code>build.rs</code>, we probe for the library and turn each include path into | |
| a <code>-I</code> argument for <code>clang</code>:</p> | |
| <pre><code class="language-rust ignore">use std::env; | |
| use std::path::PathBuf; | |
| fn main() { | |
| // Ask pkg-config for `libpng`. On success, this also prints the | |
| // `cargo:rustc-link-search` and `cargo:rustc-link-lib` lines needed to | |
| // link against the library. | |
| let library = pkg_config::probe_library("libpng") | |
| .expect("Unable to find libpng with pkg-config"); | |
| let bindings = bindgen::Builder::default() | |
| // The input header we would like to generate | |
| // bindings for. | |
| .header("wrapper.h") | |
| // Tell clang where to find the headers included by `wrapper.h`. | |
| .clang_args( | |
| library | |
| .include_paths | |
| .iter() | |
| .map(|path| format!("-I{}", path.display())), | |
| ) | |
| // Tell cargo to invalidate the built crate whenever any of the | |
| // included header files changed. | |
| .parse_callbacks(Box::new(bindgen::CargoCallbacks::new())) | |
| // Finish the builder and generate the bindings. | |
| .generate() | |
| // Unwrap the Result and panic on failure. | |
| .expect("Unable to generate bindings"); | |
| // Write the bindings to the $OUT_DIR/bindings.rs file. | |
| let out_path = PathBuf::from(env::var("OUT_DIR").unwrap()); | |
| bindings | |
| .write_to_file(out_path.join("bindings.rs")) | |
| .expect("Couldn't write bindings!"); | |
| }</code></pre> | |
| <p>A few things to note:</p> | |
| <ul> | |
| <li><code>bindgen</code> only generates the Rust declarations, it does not link anything. | |
| Linking is handled by <code>pkg_config::probe_library</code>, which prints the needed | |
| <code>cargo:rustc-link-*</code> lines, so there is no need to write them by hand as in | |
| the <a href="./tutorial-3.html">tutorial</a>.</li> | |
| <li><code>bindgen::CargoCallbacks</code> prints a <code>cargo:rerun-if-changed</code> line for | |
| <code>wrapper.h</code> and for every header it includes, so the bindings are regenerated | |
| when the library's headers change. The <code>pkg-config</code> crate prints | |
| <code>cargo:rerun-if-env-changed</code> lines for the environment variables it reads, | |
| such as <code>PKG_CONFIG_PATH</code>.</li> | |
| <li>Some libraries also require preprocessor definitions. These are available in | |
| <code>library.defines</code> and can be passed to <code>clang</code> as <code>-D</code> arguments in the same | |
| way.</li> | |
| <li>Use <a href="https://docs.rs/pkg-config/latest/pkg_config/struct.Config.html"><code>pkg_config::Config</code></a> instead of <code>probe_library</code> to | |
| require a minimum version, prefer static linking, and so on.</li> | |
| </ul> | |
| </main> | |
| <nav class="nav-wrapper" aria-label="Page navigation"> | |
| <!-- Mobile navigation buttons --> | |
| <a rel="prev" href="non-system-libraries.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | |
| <i class="fa fa-angle-left"></i> | |
| </a> | |
| <a rel="next" href="command-line-usage.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> | |
| <i class="fa fa-angle-right"></i> | |
| </a> | |
| <div style="clear: both"></div> | |
| </nav> | |
| </div> | |
| </div> | |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> | |
| <a rel="prev" href="non-system-libraries.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | |
| <i class="fa fa-angle-left"></i> | |
| </a> | |
| <a rel="next" href="command-line-usage.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> | |
| <i class="fa fa-angle-right"></i> | |
| </a> | |
| </nav> | |
| </div> | |
| <script> | |
| window.playground_copyable = true; | |
| </script> | |
| <script src="elasticlunr.min.js"></script> | |
| <script src="mark.min.js"></script> | |
| <script src="searcher.js"></script> | |
| <script src="clipboard.min.js"></script> | |
| <script src="highlight.js"></script> | |
| <script src="book.js"></script> | |
| <!-- Custom JS scripts --> | |
| </div> | |
| </body> | |
| </html> |