mirror of
https://github.com/bazel-contrib/rules_foreign_cc
synced 2024-11-30 16:42:07 +00:00
deploy: cb1d3cbcf8df55a0b5a3c39bdd1afad553139eb7
This commit is contained in:
UebelAndre
commit
206de471da
1
.nojekyll
Normal file
1
.nojekyll
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
This file makes sure that Github Pages doesn't process mdBook's output.
|
||||||
1
0.1.0/.nojekyll
Normal file
1
0.1.0/.nojekyll
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
This file makes sure that Github Pages doesn't process mdBook's output.
|
||||||
190
0.1.0/404.html
Normal file
190
0.1.0/404.html
Normal file
|
|
@ -0,0 +1,190 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title></title>
|
||||||
|
<base href="/">
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
|
||||||
|
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
|
||||||
|
|
||||||
|
<div style="clear: both"></div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
4
0.1.0/FontAwesome/css/font-awesome.css
vendored
Normal file
4
0.1.0/FontAwesome/css/font-awesome.css
vendored
Normal file
File diff suppressed because one or more lines are too long
BIN
0.1.0/FontAwesome/fonts/FontAwesome.ttf
Normal file
BIN
0.1.0/FontAwesome/fonts/FontAwesome.ttf
Normal file
Binary file not shown.
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.eot
Normal file
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.eot
Normal file
Binary file not shown.
2671
0.1.0/FontAwesome/fonts/fontawesome-webfont.svg
Normal file
2671
0.1.0/FontAwesome/fonts/fontawesome-webfont.svg
Normal file
File diff suppressed because it is too large
Load diff
|
After Width: | Height: | Size: 434 KiB |
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.ttf
Normal file
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.ttf
Normal file
Binary file not shown.
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.woff
Normal file
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.woff
Normal file
Binary file not shown.
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.woff2
Normal file
BIN
0.1.0/FontAwesome/fonts/fontawesome-webfont.woff2
Normal file
Binary file not shown.
79
0.1.0/ayu-highlight.css
Normal file
79
0.1.0/ayu-highlight.css
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
/*
|
||||||
|
Based off of the Ayu theme
|
||||||
|
Original by Dempfi (https://github.com/dempfi/ayu)
|
||||||
|
*/
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
background: #191f26;
|
||||||
|
color: #e6e1cf;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-quote {
|
||||||
|
color: #5c6773;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-attr,
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-link,
|
||||||
|
.hljs-selector-id,
|
||||||
|
.hljs-selector-class {
|
||||||
|
color: #ff7733;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-meta,
|
||||||
|
.hljs-builtin-name,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-type,
|
||||||
|
.hljs-params {
|
||||||
|
color: #ffee99;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-bullet {
|
||||||
|
color: #b8cc52;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-title,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-section {
|
||||||
|
color: #ffb454;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-selector-tag,
|
||||||
|
.hljs-symbol {
|
||||||
|
color: #ff7733;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-name {
|
||||||
|
color: #36a3d9;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-tag {
|
||||||
|
color: #00568d;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-emphasis {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
color: #91b362;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
color: #d96c75;
|
||||||
|
}
|
||||||
660
0.1.0/book.js
Normal file
660
0.1.0/book.js
Normal file
|
|
@ -0,0 +1,660 @@
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
// Fix back button cache problem
|
||||||
|
window.onunload = function () { };
|
||||||
|
|
||||||
|
// Global variable, shared between modules
|
||||||
|
function playground_text(playground) {
|
||||||
|
let code_block = playground.querySelector("code");
|
||||||
|
|
||||||
|
if (window.ace && code_block.classList.contains("editable")) {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
return editor.getValue();
|
||||||
|
} else {
|
||||||
|
return code_block.textContent;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
(function codeSnippets() {
|
||||||
|
function fetch_with_timeout(url, options, timeout = 6000) {
|
||||||
|
return Promise.race([
|
||||||
|
fetch(url, options),
|
||||||
|
new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), timeout))
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
var playgrounds = Array.from(document.querySelectorAll(".playground"));
|
||||||
|
if (playgrounds.length > 0) {
|
||||||
|
fetch_with_timeout("https://play.rust-lang.org/meta/crates", {
|
||||||
|
headers: {
|
||||||
|
'Content-Type': "application/json",
|
||||||
|
},
|
||||||
|
method: 'POST',
|
||||||
|
mode: 'cors',
|
||||||
|
})
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(response => {
|
||||||
|
// get list of crates available in the rust playground
|
||||||
|
let playground_crates = response.crates.map(item => item["id"]);
|
||||||
|
playgrounds.forEach(block => handle_crate_list_update(block, playground_crates));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function handle_crate_list_update(playground_block, playground_crates) {
|
||||||
|
// update the play buttons after receiving the response
|
||||||
|
update_play_button(playground_block, playground_crates);
|
||||||
|
|
||||||
|
// and install on change listener to dynamically update ACE editors
|
||||||
|
if (window.ace) {
|
||||||
|
let code_block = playground_block.querySelector("code");
|
||||||
|
if (code_block.classList.contains("editable")) {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
editor.addEventListener("change", function (e) {
|
||||||
|
update_play_button(playground_block, playground_crates);
|
||||||
|
});
|
||||||
|
// add Ctrl-Enter command to execute rust code
|
||||||
|
editor.commands.addCommand({
|
||||||
|
name: "run",
|
||||||
|
bindKey: {
|
||||||
|
win: "Ctrl-Enter",
|
||||||
|
mac: "Ctrl-Enter"
|
||||||
|
},
|
||||||
|
exec: _editor => run_rust_code(playground_block)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// updates the visibility of play button based on `no_run` class and
|
||||||
|
// used crates vs ones available on http://play.rust-lang.org
|
||||||
|
function update_play_button(pre_block, playground_crates) {
|
||||||
|
var play_button = pre_block.querySelector(".play-button");
|
||||||
|
|
||||||
|
// skip if code is `no_run`
|
||||||
|
if (pre_block.querySelector('code').classList.contains("no_run")) {
|
||||||
|
play_button.classList.add("hidden");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// get list of `extern crate`'s from snippet
|
||||||
|
var txt = playground_text(pre_block);
|
||||||
|
var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
|
||||||
|
var snippet_crates = [];
|
||||||
|
var item;
|
||||||
|
while (item = re.exec(txt)) {
|
||||||
|
snippet_crates.push(item[1]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if all used crates are available on play.rust-lang.org
|
||||||
|
var all_available = snippet_crates.every(function (elem) {
|
||||||
|
return playground_crates.indexOf(elem) > -1;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (all_available) {
|
||||||
|
play_button.classList.remove("hidden");
|
||||||
|
} else {
|
||||||
|
play_button.classList.add("hidden");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function run_rust_code(code_block) {
|
||||||
|
var result_block = code_block.querySelector(".result");
|
||||||
|
if (!result_block) {
|
||||||
|
result_block = document.createElement('code');
|
||||||
|
result_block.className = 'result hljs language-bash';
|
||||||
|
|
||||||
|
code_block.append(result_block);
|
||||||
|
}
|
||||||
|
|
||||||
|
let text = playground_text(code_block);
|
||||||
|
let classes = code_block.querySelector('code').classList;
|
||||||
|
let has_2018 = classes.contains("edition2018");
|
||||||
|
let edition = has_2018 ? "2018" : "2015";
|
||||||
|
|
||||||
|
var params = {
|
||||||
|
version: "stable",
|
||||||
|
optimize: "0",
|
||||||
|
code: text,
|
||||||
|
edition: edition
|
||||||
|
};
|
||||||
|
|
||||||
|
if (text.indexOf("#![feature") !== -1) {
|
||||||
|
params.version = "nightly";
|
||||||
|
}
|
||||||
|
|
||||||
|
result_block.innerText = "Running...";
|
||||||
|
|
||||||
|
fetch_with_timeout("https://play.rust-lang.org/evaluate.json", {
|
||||||
|
headers: {
|
||||||
|
'Content-Type': "application/json",
|
||||||
|
},
|
||||||
|
method: 'POST',
|
||||||
|
mode: 'cors',
|
||||||
|
body: JSON.stringify(params)
|
||||||
|
})
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(response => result_block.innerText = response.result)
|
||||||
|
.catch(error => result_block.innerText = "Playground Communication: " + error.message);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Syntax highlighting Configuration
|
||||||
|
hljs.configure({
|
||||||
|
tabReplace: ' ', // 4 spaces
|
||||||
|
languages: [], // Languages used for auto-detection
|
||||||
|
});
|
||||||
|
|
||||||
|
let code_nodes = Array
|
||||||
|
.from(document.querySelectorAll('code'))
|
||||||
|
// Don't highlight `inline code` blocks in headers.
|
||||||
|
.filter(function (node) {return !node.parentElement.classList.contains("header"); });
|
||||||
|
|
||||||
|
if (window.ace) {
|
||||||
|
// language-rust class needs to be removed for editable
|
||||||
|
// blocks or highlightjs will capture events
|
||||||
|
Array
|
||||||
|
.from(document.querySelectorAll('code.editable'))
|
||||||
|
.forEach(function (block) { block.classList.remove('language-rust'); });
|
||||||
|
|
||||||
|
Array
|
||||||
|
.from(document.querySelectorAll('code:not(.editable)'))
|
||||||
|
.forEach(function (block) { hljs.highlightBlock(block); });
|
||||||
|
} else {
|
||||||
|
code_nodes.forEach(function (block) { hljs.highlightBlock(block); });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Adding the hljs class gives code blocks the color css
|
||||||
|
// even if highlighting doesn't apply
|
||||||
|
code_nodes.forEach(function (block) { block.classList.add('hljs'); });
|
||||||
|
|
||||||
|
Array.from(document.querySelectorAll("code.language-rust")).forEach(function (block) {
|
||||||
|
|
||||||
|
var lines = Array.from(block.querySelectorAll('.boring'));
|
||||||
|
// If no lines were hidden, return
|
||||||
|
if (!lines.length) { return; }
|
||||||
|
block.classList.add("hide-boring");
|
||||||
|
|
||||||
|
var buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
buttons.innerHTML = "<button class=\"fa fa-eye\" title=\"Show hidden lines\" aria-label=\"Show hidden lines\"></button>";
|
||||||
|
|
||||||
|
// add expand button
|
||||||
|
var pre_block = block.parentNode;
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
|
||||||
|
pre_block.querySelector('.buttons').addEventListener('click', function (e) {
|
||||||
|
if (e.target.classList.contains('fa-eye')) {
|
||||||
|
e.target.classList.remove('fa-eye');
|
||||||
|
e.target.classList.add('fa-eye-slash');
|
||||||
|
e.target.title = 'Hide lines';
|
||||||
|
e.target.setAttribute('aria-label', e.target.title);
|
||||||
|
|
||||||
|
block.classList.remove('hide-boring');
|
||||||
|
} else if (e.target.classList.contains('fa-eye-slash')) {
|
||||||
|
e.target.classList.remove('fa-eye-slash');
|
||||||
|
e.target.classList.add('fa-eye');
|
||||||
|
e.target.title = 'Show hidden lines';
|
||||||
|
e.target.setAttribute('aria-label', e.target.title);
|
||||||
|
|
||||||
|
block.classList.add('hide-boring');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
if (window.playground_copyable) {
|
||||||
|
Array.from(document.querySelectorAll('pre code')).forEach(function (block) {
|
||||||
|
var pre_block = block.parentNode;
|
||||||
|
if (!pre_block.classList.contains('playground')) {
|
||||||
|
var buttons = pre_block.querySelector(".buttons");
|
||||||
|
if (!buttons) {
|
||||||
|
buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
var clipButton = document.createElement('button');
|
||||||
|
clipButton.className = 'fa fa-copy clip-button';
|
||||||
|
clipButton.title = 'Copy to clipboard';
|
||||||
|
clipButton.setAttribute('aria-label', clipButton.title);
|
||||||
|
clipButton.innerHTML = '<i class=\"tooltiptext\"></i>';
|
||||||
|
|
||||||
|
buttons.insertBefore(clipButton, buttons.firstChild);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process playground code blocks
|
||||||
|
Array.from(document.querySelectorAll(".playground")).forEach(function (pre_block) {
|
||||||
|
// Add play button
|
||||||
|
var buttons = pre_block.querySelector(".buttons");
|
||||||
|
if (!buttons) {
|
||||||
|
buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
var runCodeButton = document.createElement('button');
|
||||||
|
runCodeButton.className = 'fa fa-play play-button';
|
||||||
|
runCodeButton.hidden = true;
|
||||||
|
runCodeButton.title = 'Run this code';
|
||||||
|
runCodeButton.setAttribute('aria-label', runCodeButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(runCodeButton, buttons.firstChild);
|
||||||
|
runCodeButton.addEventListener('click', function (e) {
|
||||||
|
run_rust_code(pre_block);
|
||||||
|
});
|
||||||
|
|
||||||
|
if (window.playground_copyable) {
|
||||||
|
var copyCodeClipboardButton = document.createElement('button');
|
||||||
|
copyCodeClipboardButton.className = 'fa fa-copy clip-button';
|
||||||
|
copyCodeClipboardButton.innerHTML = '<i class="tooltiptext"></i>';
|
||||||
|
copyCodeClipboardButton.title = 'Copy to clipboard';
|
||||||
|
copyCodeClipboardButton.setAttribute('aria-label', copyCodeClipboardButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(copyCodeClipboardButton, buttons.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
let code_block = pre_block.querySelector("code");
|
||||||
|
if (window.ace && code_block.classList.contains("editable")) {
|
||||||
|
var undoChangesButton = document.createElement('button');
|
||||||
|
undoChangesButton.className = 'fa fa-history reset-button';
|
||||||
|
undoChangesButton.title = 'Undo changes';
|
||||||
|
undoChangesButton.setAttribute('aria-label', undoChangesButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(undoChangesButton, buttons.firstChild);
|
||||||
|
|
||||||
|
undoChangesButton.addEventListener('click', function () {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
editor.setValue(editor.originalCode);
|
||||||
|
editor.clearSelection();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function themes() {
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var themeToggleButton = document.getElementById('theme-toggle');
|
||||||
|
var themePopup = document.getElementById('theme-list');
|
||||||
|
var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
|
||||||
|
var stylesheets = {
|
||||||
|
ayuHighlight: document.querySelector("[href$='ayu-highlight.css']"),
|
||||||
|
tomorrowNight: document.querySelector("[href$='tomorrow-night.css']"),
|
||||||
|
highlight: document.querySelector("[href$='highlight.css']"),
|
||||||
|
};
|
||||||
|
|
||||||
|
function showThemes() {
|
||||||
|
themePopup.style.display = 'block';
|
||||||
|
themeToggleButton.setAttribute('aria-expanded', true);
|
||||||
|
themePopup.querySelector("button#" + get_theme()).focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
function hideThemes() {
|
||||||
|
themePopup.style.display = 'none';
|
||||||
|
themeToggleButton.setAttribute('aria-expanded', false);
|
||||||
|
themeToggleButton.focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_theme() {
|
||||||
|
var theme;
|
||||||
|
try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
|
||||||
|
if (theme === null || theme === undefined) {
|
||||||
|
return default_theme;
|
||||||
|
} else {
|
||||||
|
return theme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function set_theme(theme, store = true) {
|
||||||
|
let ace_theme;
|
||||||
|
|
||||||
|
if (theme == 'coal' || theme == 'navy') {
|
||||||
|
stylesheets.ayuHighlight.disabled = true;
|
||||||
|
stylesheets.tomorrowNight.disabled = false;
|
||||||
|
stylesheets.highlight.disabled = true;
|
||||||
|
|
||||||
|
ace_theme = "ace/theme/tomorrow_night";
|
||||||
|
} else if (theme == 'ayu') {
|
||||||
|
stylesheets.ayuHighlight.disabled = false;
|
||||||
|
stylesheets.tomorrowNight.disabled = true;
|
||||||
|
stylesheets.highlight.disabled = true;
|
||||||
|
ace_theme = "ace/theme/tomorrow_night";
|
||||||
|
} else {
|
||||||
|
stylesheets.ayuHighlight.disabled = true;
|
||||||
|
stylesheets.tomorrowNight.disabled = true;
|
||||||
|
stylesheets.highlight.disabled = false;
|
||||||
|
ace_theme = "ace/theme/dawn";
|
||||||
|
}
|
||||||
|
|
||||||
|
setTimeout(function () {
|
||||||
|
themeColorMetaTag.content = getComputedStyle(document.body).backgroundColor;
|
||||||
|
}, 1);
|
||||||
|
|
||||||
|
if (window.ace && window.editors) {
|
||||||
|
window.editors.forEach(function (editor) {
|
||||||
|
editor.setTheme(ace_theme);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
var previousTheme = get_theme();
|
||||||
|
|
||||||
|
if (store) {
|
||||||
|
try { localStorage.setItem('mdbook-theme', theme); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
html.classList.remove(previousTheme);
|
||||||
|
html.classList.add(theme);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set theme
|
||||||
|
var theme = get_theme();
|
||||||
|
|
||||||
|
set_theme(theme, false);
|
||||||
|
|
||||||
|
themeToggleButton.addEventListener('click', function () {
|
||||||
|
if (themePopup.style.display === 'block') {
|
||||||
|
hideThemes();
|
||||||
|
} else {
|
||||||
|
showThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
themePopup.addEventListener('click', function (e) {
|
||||||
|
var theme = e.target.id || e.target.parentElement.id;
|
||||||
|
set_theme(theme);
|
||||||
|
});
|
||||||
|
|
||||||
|
themePopup.addEventListener('focusout', function(e) {
|
||||||
|
// e.relatedTarget is null in Safari and Firefox on macOS (see workaround below)
|
||||||
|
if (!!e.relatedTarget && !themeToggleButton.contains(e.relatedTarget) && !themePopup.contains(e.relatedTarget)) {
|
||||||
|
hideThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
|
||||||
|
document.addEventListener('click', function(e) {
|
||||||
|
if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
|
||||||
|
hideThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
document.addEventListener('keydown', function (e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
|
||||||
|
if (!themePopup.contains(e.target)) { return; }
|
||||||
|
|
||||||
|
switch (e.key) {
|
||||||
|
case 'Escape':
|
||||||
|
e.preventDefault();
|
||||||
|
hideThemes();
|
||||||
|
break;
|
||||||
|
case 'ArrowUp':
|
||||||
|
e.preventDefault();
|
||||||
|
var li = document.activeElement.parentElement;
|
||||||
|
if (li && li.previousElementSibling) {
|
||||||
|
li.previousElementSibling.querySelector('button').focus();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'ArrowDown':
|
||||||
|
e.preventDefault();
|
||||||
|
var li = document.activeElement.parentElement;
|
||||||
|
if (li && li.nextElementSibling) {
|
||||||
|
li.nextElementSibling.querySelector('button').focus();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'Home':
|
||||||
|
e.preventDefault();
|
||||||
|
themePopup.querySelector('li:first-child button').focus();
|
||||||
|
break;
|
||||||
|
case 'End':
|
||||||
|
e.preventDefault();
|
||||||
|
themePopup.querySelector('li:last-child button').focus();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function sidebar() {
|
||||||
|
var html = document.querySelector("html");
|
||||||
|
var sidebar = document.getElementById("sidebar");
|
||||||
|
var sidebarLinks = document.querySelectorAll('#sidebar a');
|
||||||
|
var sidebarToggleButton = document.getElementById("sidebar-toggle");
|
||||||
|
var sidebarResizeHandle = document.getElementById("sidebar-resize-handle");
|
||||||
|
var firstContact = null;
|
||||||
|
|
||||||
|
function showSidebar() {
|
||||||
|
html.classList.remove('sidebar-hidden')
|
||||||
|
html.classList.add('sidebar-visible');
|
||||||
|
Array.from(sidebarLinks).forEach(function (link) {
|
||||||
|
link.setAttribute('tabIndex', 0);
|
||||||
|
});
|
||||||
|
sidebarToggleButton.setAttribute('aria-expanded', true);
|
||||||
|
sidebar.setAttribute('aria-hidden', false);
|
||||||
|
try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
|
||||||
|
|
||||||
|
function toggleSection(ev) {
|
||||||
|
ev.currentTarget.parentElement.classList.toggle('expanded');
|
||||||
|
}
|
||||||
|
|
||||||
|
Array.from(sidebarAnchorToggles).forEach(function (el) {
|
||||||
|
el.addEventListener('click', toggleSection);
|
||||||
|
});
|
||||||
|
|
||||||
|
function hideSidebar() {
|
||||||
|
html.classList.remove('sidebar-visible')
|
||||||
|
html.classList.add('sidebar-hidden');
|
||||||
|
Array.from(sidebarLinks).forEach(function (link) {
|
||||||
|
link.setAttribute('tabIndex', -1);
|
||||||
|
});
|
||||||
|
sidebarToggleButton.setAttribute('aria-expanded', false);
|
||||||
|
sidebar.setAttribute('aria-hidden', true);
|
||||||
|
try { localStorage.setItem('mdbook-sidebar', 'hidden'); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
// Toggle sidebar
|
||||||
|
sidebarToggleButton.addEventListener('click', function sidebarToggle() {
|
||||||
|
if (html.classList.contains("sidebar-hidden")) {
|
||||||
|
var current_width = parseInt(
|
||||||
|
document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
|
||||||
|
if (current_width < 150) {
|
||||||
|
document.documentElement.style.setProperty('--sidebar-width', '150px');
|
||||||
|
}
|
||||||
|
showSidebar();
|
||||||
|
} else if (html.classList.contains("sidebar-visible")) {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
if (getComputedStyle(sidebar)['transform'] === 'none') {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
showSidebar();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
sidebarResizeHandle.addEventListener('mousedown', initResize, false);
|
||||||
|
|
||||||
|
function initResize(e) {
|
||||||
|
window.addEventListener('mousemove', resize, false);
|
||||||
|
window.addEventListener('mouseup', stopResize, false);
|
||||||
|
html.classList.add('sidebar-resizing');
|
||||||
|
}
|
||||||
|
function resize(e) {
|
||||||
|
var pos = (e.clientX - sidebar.offsetLeft);
|
||||||
|
if (pos < 20) {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
if (html.classList.contains("sidebar-hidden")) {
|
||||||
|
showSidebar();
|
||||||
|
}
|
||||||
|
pos = Math.min(pos, window.innerWidth - 100);
|
||||||
|
document.documentElement.style.setProperty('--sidebar-width', pos + 'px');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//on mouseup remove windows functions mousemove & mouseup
|
||||||
|
function stopResize(e) {
|
||||||
|
html.classList.remove('sidebar-resizing');
|
||||||
|
window.removeEventListener('mousemove', resize, false);
|
||||||
|
window.removeEventListener('mouseup', stopResize, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
document.addEventListener('touchstart', function (e) {
|
||||||
|
firstContact = {
|
||||||
|
x: e.touches[0].clientX,
|
||||||
|
time: Date.now()
|
||||||
|
};
|
||||||
|
}, { passive: true });
|
||||||
|
|
||||||
|
document.addEventListener('touchmove', function (e) {
|
||||||
|
if (!firstContact)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var curX = e.touches[0].clientX;
|
||||||
|
var xDiff = curX - firstContact.x,
|
||||||
|
tDiff = Date.now() - firstContact.time;
|
||||||
|
|
||||||
|
if (tDiff < 250 && Math.abs(xDiff) >= 150) {
|
||||||
|
if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
|
||||||
|
showSidebar();
|
||||||
|
else if (xDiff < 0 && curX < 300)
|
||||||
|
hideSidebar();
|
||||||
|
|
||||||
|
firstContact = null;
|
||||||
|
}
|
||||||
|
}, { passive: true });
|
||||||
|
|
||||||
|
// Scroll sidebar to current active section
|
||||||
|
var activeSection = document.getElementById("sidebar").querySelector(".active");
|
||||||
|
if (activeSection) {
|
||||||
|
// https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
|
||||||
|
activeSection.scrollIntoView({ block: 'center' });
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function chapterNavigation() {
|
||||||
|
document.addEventListener('keydown', function (e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
|
||||||
|
if (window.search && window.search.hasFocus()) { return; }
|
||||||
|
|
||||||
|
switch (e.key) {
|
||||||
|
case 'ArrowRight':
|
||||||
|
e.preventDefault();
|
||||||
|
var nextButton = document.querySelector('.nav-chapters.next');
|
||||||
|
if (nextButton) {
|
||||||
|
window.location.href = nextButton.href;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'ArrowLeft':
|
||||||
|
e.preventDefault();
|
||||||
|
var previousButton = document.querySelector('.nav-chapters.previous');
|
||||||
|
if (previousButton) {
|
||||||
|
window.location.href = previousButton.href;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function clipboard() {
|
||||||
|
var clipButtons = document.querySelectorAll('.clip-button');
|
||||||
|
|
||||||
|
function hideTooltip(elem) {
|
||||||
|
elem.firstChild.innerText = "";
|
||||||
|
elem.className = 'fa fa-copy clip-button';
|
||||||
|
}
|
||||||
|
|
||||||
|
function showTooltip(elem, msg) {
|
||||||
|
elem.firstChild.innerText = msg;
|
||||||
|
elem.className = 'fa fa-copy tooltipped';
|
||||||
|
}
|
||||||
|
|
||||||
|
var clipboardSnippets = new ClipboardJS('.clip-button', {
|
||||||
|
text: function (trigger) {
|
||||||
|
hideTooltip(trigger);
|
||||||
|
let playground = trigger.closest("pre");
|
||||||
|
return playground_text(playground);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
Array.from(clipButtons).forEach(function (clipButton) {
|
||||||
|
clipButton.addEventListener('mouseout', function (e) {
|
||||||
|
hideTooltip(e.currentTarget);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
clipboardSnippets.on('success', function (e) {
|
||||||
|
e.clearSelection();
|
||||||
|
showTooltip(e.trigger, "Copied!");
|
||||||
|
});
|
||||||
|
|
||||||
|
clipboardSnippets.on('error', function (e) {
|
||||||
|
showTooltip(e.trigger, "Clipboard error!");
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function scrollToTop () {
|
||||||
|
var menuTitle = document.querySelector('.menu-title');
|
||||||
|
|
||||||
|
menuTitle.addEventListener('click', function () {
|
||||||
|
document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function controllMenu() {
|
||||||
|
var menu = document.getElementById('menu-bar');
|
||||||
|
|
||||||
|
(function controllPosition() {
|
||||||
|
var scrollTop = document.scrollingElement.scrollTop;
|
||||||
|
var prevScrollTop = scrollTop;
|
||||||
|
var minMenuY = -menu.clientHeight - 50;
|
||||||
|
// When the script loads, the page can be at any scroll (e.g. if you reforesh it).
|
||||||
|
menu.style.top = scrollTop + 'px';
|
||||||
|
// Same as parseInt(menu.style.top.slice(0, -2), but faster
|
||||||
|
var topCache = menu.style.top.slice(0, -2);
|
||||||
|
menu.classList.remove('sticky');
|
||||||
|
var stickyCache = false; // Same as menu.classList.contains('sticky'), but faster
|
||||||
|
document.addEventListener('scroll', function () {
|
||||||
|
scrollTop = Math.max(document.scrollingElement.scrollTop, 0);
|
||||||
|
// `null` means that it doesn't need to be updated
|
||||||
|
var nextSticky = null;
|
||||||
|
var nextTop = null;
|
||||||
|
var scrollDown = scrollTop > prevScrollTop;
|
||||||
|
var menuPosAbsoluteY = topCache - scrollTop;
|
||||||
|
if (scrollDown) {
|
||||||
|
nextSticky = false;
|
||||||
|
if (menuPosAbsoluteY > 0) {
|
||||||
|
nextTop = prevScrollTop;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (menuPosAbsoluteY > 0) {
|
||||||
|
nextSticky = true;
|
||||||
|
} else if (menuPosAbsoluteY < minMenuY) {
|
||||||
|
nextTop = prevScrollTop + minMenuY;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (nextSticky === true && stickyCache === false) {
|
||||||
|
menu.classList.add('sticky');
|
||||||
|
stickyCache = true;
|
||||||
|
} else if (nextSticky === false && stickyCache === true) {
|
||||||
|
menu.classList.remove('sticky');
|
||||||
|
stickyCache = false;
|
||||||
|
}
|
||||||
|
if (nextTop !== null) {
|
||||||
|
menu.style.top = nextTop + 'px';
|
||||||
|
topCache = nextTop;
|
||||||
|
}
|
||||||
|
prevScrollTop = scrollTop;
|
||||||
|
}, { passive: true });
|
||||||
|
})();
|
||||||
|
(function controllBorder() {
|
||||||
|
menu.classList.remove('bordered');
|
||||||
|
document.addEventListener('scroll', function () {
|
||||||
|
if (menu.offsetTop === 0) {
|
||||||
|
menu.classList.remove('bordered');
|
||||||
|
} else {
|
||||||
|
menu.classList.add('bordered');
|
||||||
|
}
|
||||||
|
}, { passive: true });
|
||||||
|
})();
|
||||||
|
})();
|
||||||
7
0.1.0/clipboard.min.js
vendored
Normal file
7
0.1.0/clipboard.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
495
0.1.0/css/chrome.css
Normal file
495
0.1.0/css/chrome.css
Normal file
|
|
@ -0,0 +1,495 @@
|
||||||
|
/* CSS for UI elements (a.k.a. chrome) */
|
||||||
|
|
||||||
|
@import 'variables.css';
|
||||||
|
|
||||||
|
::-webkit-scrollbar {
|
||||||
|
background: var(--bg);
|
||||||
|
}
|
||||||
|
::-webkit-scrollbar-thumb {
|
||||||
|
background: var(--scrollbar);
|
||||||
|
}
|
||||||
|
html {
|
||||||
|
scrollbar-color: var(--scrollbar) var(--bg);
|
||||||
|
}
|
||||||
|
#searchresults a,
|
||||||
|
.content a:link,
|
||||||
|
a:visited,
|
||||||
|
a > .hljs {
|
||||||
|
color: var(--links);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Menu Bar */
|
||||||
|
|
||||||
|
#menu-bar,
|
||||||
|
#menu-bar-hover-placeholder {
|
||||||
|
z-index: 101;
|
||||||
|
margin: auto calc(0px - var(--page-padding));
|
||||||
|
}
|
||||||
|
#menu-bar {
|
||||||
|
position: relative;
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
background-color: var(--bg);
|
||||||
|
border-bottom-color: var(--bg);
|
||||||
|
border-bottom-width: 1px;
|
||||||
|
border-bottom-style: solid;
|
||||||
|
}
|
||||||
|
#menu-bar.sticky,
|
||||||
|
.js #menu-bar-hover-placeholder:hover + #menu-bar,
|
||||||
|
.js #menu-bar:hover,
|
||||||
|
.js.sidebar-visible #menu-bar {
|
||||||
|
position: -webkit-sticky;
|
||||||
|
position: sticky;
|
||||||
|
top: 0 !important;
|
||||||
|
}
|
||||||
|
#menu-bar-hover-placeholder {
|
||||||
|
position: sticky;
|
||||||
|
position: -webkit-sticky;
|
||||||
|
top: 0;
|
||||||
|
height: var(--menu-bar-height);
|
||||||
|
}
|
||||||
|
#menu-bar.bordered {
|
||||||
|
border-bottom-color: var(--table-border-color);
|
||||||
|
}
|
||||||
|
#menu-bar i, #menu-bar .icon-button {
|
||||||
|
position: relative;
|
||||||
|
padding: 0 8px;
|
||||||
|
z-index: 10;
|
||||||
|
line-height: var(--menu-bar-height);
|
||||||
|
cursor: pointer;
|
||||||
|
transition: color 0.5s;
|
||||||
|
}
|
||||||
|
@media only screen and (max-width: 420px) {
|
||||||
|
#menu-bar i, #menu-bar .icon-button {
|
||||||
|
padding: 0 5px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon-button {
|
||||||
|
border: none;
|
||||||
|
background: none;
|
||||||
|
padding: 0;
|
||||||
|
color: inherit;
|
||||||
|
}
|
||||||
|
.icon-button i {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.right-buttons {
|
||||||
|
margin: 0 15px;
|
||||||
|
}
|
||||||
|
.right-buttons a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left-buttons {
|
||||||
|
display: flex;
|
||||||
|
margin: 0 5px;
|
||||||
|
}
|
||||||
|
.no-js .left-buttons {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-title {
|
||||||
|
display: inline-block;
|
||||||
|
font-weight: 200;
|
||||||
|
font-size: 2.4rem;
|
||||||
|
line-height: var(--menu-bar-height);
|
||||||
|
text-align: center;
|
||||||
|
margin: 0;
|
||||||
|
flex: 1;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
.js .menu-title {
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-bar,
|
||||||
|
.menu-bar:visited,
|
||||||
|
.nav-chapters,
|
||||||
|
.nav-chapters:visited,
|
||||||
|
.mobile-nav-chapters,
|
||||||
|
.mobile-nav-chapters:visited,
|
||||||
|
.menu-bar .icon-button,
|
||||||
|
.menu-bar a i {
|
||||||
|
color: var(--icons);
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-bar i:hover,
|
||||||
|
.menu-bar .icon-button:hover,
|
||||||
|
.nav-chapters:hover,
|
||||||
|
.mobile-nav-chapters i:hover {
|
||||||
|
color: var(--icons-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Nav Icons */
|
||||||
|
|
||||||
|
.nav-chapters {
|
||||||
|
font-size: 2.5em;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
margin: 0;
|
||||||
|
max-width: 150px;
|
||||||
|
min-width: 90px;
|
||||||
|
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
align-content: center;
|
||||||
|
flex-direction: column;
|
||||||
|
|
||||||
|
transition: color 0.5s, background-color 0.5s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-chapters:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
background-color: var(--theme-hover);
|
||||||
|
transition: background-color 0.15s, color 0.15s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-wrapper {
|
||||||
|
margin-top: 50px;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mobile-nav-chapters {
|
||||||
|
font-size: 2.5em;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
width: 90px;
|
||||||
|
border-radius: 5px;
|
||||||
|
background-color: var(--sidebar-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.previous {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.next {
|
||||||
|
float: right;
|
||||||
|
right: var(--page-padding);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media only screen and (max-width: 1080px) {
|
||||||
|
.nav-wide-wrapper { display: none; }
|
||||||
|
.nav-wrapper { display: block; }
|
||||||
|
}
|
||||||
|
|
||||||
|
@media only screen and (max-width: 1380px) {
|
||||||
|
.sidebar-visible .nav-wide-wrapper { display: none; }
|
||||||
|
.sidebar-visible .nav-wrapper { display: block; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Inline code */
|
||||||
|
|
||||||
|
:not(pre) > .hljs {
|
||||||
|
display: inline;
|
||||||
|
padding: 0.1em 0.3em;
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
:not(pre):not(a) > .hljs {
|
||||||
|
color: var(--inline-code-color);
|
||||||
|
overflow-x: initial;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover > .hljs {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
pre > .buttons {
|
||||||
|
position: absolute;
|
||||||
|
z-index: 100;
|
||||||
|
right: 5px;
|
||||||
|
top: 5px;
|
||||||
|
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
pre > .buttons :hover {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
pre > .buttons i {
|
||||||
|
margin-left: 8px;
|
||||||
|
}
|
||||||
|
pre > .buttons button {
|
||||||
|
color: inherit;
|
||||||
|
background: transparent;
|
||||||
|
border: none;
|
||||||
|
cursor: inherit;
|
||||||
|
}
|
||||||
|
pre > .result {
|
||||||
|
margin-top: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Search */
|
||||||
|
|
||||||
|
#searchresults a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
mark {
|
||||||
|
border-radius: 2px;
|
||||||
|
padding: 0 3px 1px 3px;
|
||||||
|
margin: 0 -3px -1px -3px;
|
||||||
|
background-color: var(--search-mark-bg);
|
||||||
|
transition: background-color 300ms linear;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
mark.fade-out {
|
||||||
|
background-color: rgba(0,0,0,0) !important;
|
||||||
|
cursor: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchbar-outer {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
}
|
||||||
|
|
||||||
|
#searchbar {
|
||||||
|
width: 100%;
|
||||||
|
margin: 5px auto 0px auto;
|
||||||
|
padding: 10px 16px;
|
||||||
|
transition: box-shadow 300ms ease-in-out;
|
||||||
|
border: 1px solid var(--searchbar-border-color);
|
||||||
|
border-radius: 3px;
|
||||||
|
background-color: var(--searchbar-bg);
|
||||||
|
color: var(--searchbar-fg);
|
||||||
|
}
|
||||||
|
#searchbar:focus,
|
||||||
|
#searchbar.active {
|
||||||
|
box-shadow: 0 0 3px var(--searchbar-shadow-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchresults-header {
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 1em;
|
||||||
|
padding: 18px 0 0 5px;
|
||||||
|
color: var(--searchresults-header-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchresults-outer {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
border-bottom: 1px dashed var(--searchresults-border-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
ul#searchresults {
|
||||||
|
list-style: none;
|
||||||
|
padding-left: 20px;
|
||||||
|
}
|
||||||
|
ul#searchresults li {
|
||||||
|
margin: 10px 0px;
|
||||||
|
padding: 2px;
|
||||||
|
border-radius: 2px;
|
||||||
|
}
|
||||||
|
ul#searchresults li.focus {
|
||||||
|
background-color: var(--searchresults-li-bg);
|
||||||
|
}
|
||||||
|
ul#searchresults span.teaser {
|
||||||
|
display: block;
|
||||||
|
clear: both;
|
||||||
|
margin: 5px 0 0 20px;
|
||||||
|
font-size: 0.8em;
|
||||||
|
}
|
||||||
|
ul#searchresults span.teaser em {
|
||||||
|
font-weight: bold;
|
||||||
|
font-style: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Sidebar */
|
||||||
|
|
||||||
|
.sidebar {
|
||||||
|
position: fixed;
|
||||||
|
left: 0;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
width: var(--sidebar-width);
|
||||||
|
font-size: 0.875em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
-webkit-overflow-scrolling: touch;
|
||||||
|
overscroll-behavior-y: contain;
|
||||||
|
background-color: var(--sidebar-bg);
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
}
|
||||||
|
.sidebar-resizing {
|
||||||
|
-moz-user-select: none;
|
||||||
|
-webkit-user-select: none;
|
||||||
|
-ms-user-select: none;
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
.js:not(.sidebar-resizing) .sidebar {
|
||||||
|
transition: transform 0.3s; /* Animation: slide away */
|
||||||
|
}
|
||||||
|
.sidebar code {
|
||||||
|
line-height: 2em;
|
||||||
|
}
|
||||||
|
.sidebar .sidebar-scrollbox {
|
||||||
|
overflow-y: auto;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
left: 0;
|
||||||
|
right: 0;
|
||||||
|
padding: 10px 10px;
|
||||||
|
}
|
||||||
|
.sidebar .sidebar-resize-handle {
|
||||||
|
position: absolute;
|
||||||
|
cursor: col-resize;
|
||||||
|
width: 0;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
}
|
||||||
|
.js .sidebar .sidebar-resize-handle {
|
||||||
|
cursor: col-resize;
|
||||||
|
width: 5px;
|
||||||
|
}
|
||||||
|
.sidebar-hidden .sidebar {
|
||||||
|
transform: translateX(calc(0px - var(--sidebar-width)));
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar {
|
||||||
|
background: var(--sidebar-bg);
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar-thumb {
|
||||||
|
background: var(--scrollbar);
|
||||||
|
}
|
||||||
|
|
||||||
|
.sidebar-visible .page-wrapper {
|
||||||
|
transform: translateX(var(--sidebar-width));
|
||||||
|
}
|
||||||
|
@media only screen and (min-width: 620px) {
|
||||||
|
.sidebar-visible .page-wrapper {
|
||||||
|
transform: none;
|
||||||
|
margin-left: var(--sidebar-width);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter {
|
||||||
|
list-style: none outside none;
|
||||||
|
padding-left: 0;
|
||||||
|
line-height: 2.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter ol {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li {
|
||||||
|
display: flex;
|
||||||
|
color: var(--sidebar-non-existant);
|
||||||
|
}
|
||||||
|
.chapter li a {
|
||||||
|
display: block;
|
||||||
|
padding: 0;
|
||||||
|
text-decoration: none;
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li a:hover {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li a.active {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li > a.toggle {
|
||||||
|
cursor: pointer;
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
padding: 0 10px;
|
||||||
|
user-select: none;
|
||||||
|
opacity: 0.68;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li > a.toggle div {
|
||||||
|
transition: transform 0.5s;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* collapse the section */
|
||||||
|
.chapter li:not(.expanded) + li > ol {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.chapter-item {
|
||||||
|
line-height: 1.5em;
|
||||||
|
margin-top: 0.6em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.expanded > a.toggle div {
|
||||||
|
transform: rotate(90deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.spacer {
|
||||||
|
width: 100%;
|
||||||
|
height: 3px;
|
||||||
|
margin: 5px 0px;
|
||||||
|
}
|
||||||
|
.chapter .spacer {
|
||||||
|
background-color: var(--sidebar-spacer);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (-moz-touch-enabled: 1), (pointer: coarse) {
|
||||||
|
.chapter li a { padding: 5px 0; }
|
||||||
|
.spacer { margin: 10px 0; }
|
||||||
|
}
|
||||||
|
|
||||||
|
.section {
|
||||||
|
list-style: none outside none;
|
||||||
|
padding-left: 20px;
|
||||||
|
line-height: 1.9em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Theme Menu Popup */
|
||||||
|
|
||||||
|
.theme-popup {
|
||||||
|
position: absolute;
|
||||||
|
left: 10px;
|
||||||
|
top: var(--menu-bar-height);
|
||||||
|
z-index: 1000;
|
||||||
|
border-radius: 4px;
|
||||||
|
font-size: 0.7em;
|
||||||
|
color: var(--fg);
|
||||||
|
background: var(--theme-popup-bg);
|
||||||
|
border: 1px solid var(--theme-popup-border);
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.theme-popup .default {
|
||||||
|
color: var(--icons);
|
||||||
|
}
|
||||||
|
.theme-popup .theme {
|
||||||
|
width: 100%;
|
||||||
|
border: 0;
|
||||||
|
margin: 0;
|
||||||
|
padding: 2px 10px;
|
||||||
|
line-height: 25px;
|
||||||
|
white-space: nowrap;
|
||||||
|
text-align: left;
|
||||||
|
cursor: pointer;
|
||||||
|
color: inherit;
|
||||||
|
background: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
.theme-popup .theme:hover {
|
||||||
|
background-color: var(--theme-hover);
|
||||||
|
}
|
||||||
|
.theme-popup .theme:hover:first-child,
|
||||||
|
.theme-popup .theme:hover:last-child {
|
||||||
|
border-top-left-radius: inherit;
|
||||||
|
border-top-right-radius: inherit;
|
||||||
|
}
|
||||||
177
0.1.0/css/general.css
Normal file
177
0.1.0/css/general.css
Normal file
|
|
@ -0,0 +1,177 @@
|
||||||
|
/* Base styles and content styles */
|
||||||
|
|
||||||
|
@import 'variables.css';
|
||||||
|
|
||||||
|
:root {
|
||||||
|
/* Browser default font-size is 16px, this way 1 rem = 10px */
|
||||||
|
font-size: 62.5%;
|
||||||
|
}
|
||||||
|
|
||||||
|
html {
|
||||||
|
font-family: "Open Sans", sans-serif;
|
||||||
|
color: var(--fg);
|
||||||
|
background-color: var(--bg);
|
||||||
|
text-size-adjust: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
font-size: 1.6rem;
|
||||||
|
overflow-x: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace !important;
|
||||||
|
font-size: 0.875em; /* please adjust the ace font size accordingly in editor.js */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Don't change font size in headers. */
|
||||||
|
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||||
|
font-size: unset;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left { float: left; }
|
||||||
|
.right { float: right; }
|
||||||
|
.boring { opacity: 0.6; }
|
||||||
|
.hide-boring .boring { display: none; }
|
||||||
|
.hidden { display: none !important; }
|
||||||
|
|
||||||
|
h2, h3 { margin-top: 2.5em; }
|
||||||
|
h4, h5 { margin-top: 2em; }
|
||||||
|
|
||||||
|
.header + .header h3,
|
||||||
|
.header + .header h4,
|
||||||
|
.header + .header h5 {
|
||||||
|
margin-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1:target::before,
|
||||||
|
h2:target::before,
|
||||||
|
h3:target::before,
|
||||||
|
h4:target::before,
|
||||||
|
h5:target::before,
|
||||||
|
h6:target::before {
|
||||||
|
display: inline-block;
|
||||||
|
content: "»";
|
||||||
|
margin-left: -30px;
|
||||||
|
width: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* This is broken on Safari as of version 14, but is fixed
|
||||||
|
in Safari Technology Preview 117 which I think will be Safari 14.2.
|
||||||
|
https://bugs.webkit.org/show_bug.cgi?id=218076
|
||||||
|
*/
|
||||||
|
:target {
|
||||||
|
scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
|
||||||
|
}
|
||||||
|
|
||||||
|
.page {
|
||||||
|
outline: 0;
|
||||||
|
padding: 0 var(--page-padding);
|
||||||
|
margin-top: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
|
||||||
|
}
|
||||||
|
.page-wrapper {
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
.js:not(.sidebar-resizing) .page-wrapper {
|
||||||
|
transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
|
||||||
|
}
|
||||||
|
|
||||||
|
.content {
|
||||||
|
overflow-y: auto;
|
||||||
|
padding: 0 15px;
|
||||||
|
padding-bottom: 50px;
|
||||||
|
}
|
||||||
|
.content main {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
}
|
||||||
|
.content p { line-height: 1.45em; }
|
||||||
|
.content ol { line-height: 1.45em; }
|
||||||
|
.content ul { line-height: 1.45em; }
|
||||||
|
.content a { text-decoration: none; }
|
||||||
|
.content a:hover { text-decoration: underline; }
|
||||||
|
.content img, .content video { max-width: 100%; }
|
||||||
|
.content .header:link,
|
||||||
|
.content .header:visited {
|
||||||
|
color: var(--fg);
|
||||||
|
}
|
||||||
|
.content .header:link,
|
||||||
|
.content .header:visited:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
table {
|
||||||
|
margin: 0 auto;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table td {
|
||||||
|
padding: 3px 20px;
|
||||||
|
border: 1px var(--table-border-color) solid;
|
||||||
|
}
|
||||||
|
table thead {
|
||||||
|
background: var(--table-header-bg);
|
||||||
|
}
|
||||||
|
table thead td {
|
||||||
|
font-weight: 700;
|
||||||
|
border: none;
|
||||||
|
}
|
||||||
|
table thead th {
|
||||||
|
padding: 3px 20px;
|
||||||
|
}
|
||||||
|
table thead tr {
|
||||||
|
border: 1px var(--table-header-bg) solid;
|
||||||
|
}
|
||||||
|
/* Alternate background colors for rows */
|
||||||
|
table tbody tr:nth-child(2n) {
|
||||||
|
background: var(--table-alternate-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
margin: 20px 0;
|
||||||
|
padding: 0 20px;
|
||||||
|
color: var(--fg);
|
||||||
|
background-color: var(--quote-bg);
|
||||||
|
border-top: .1em solid var(--quote-border);
|
||||||
|
border-bottom: .1em solid var(--quote-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
:not(.footnote-definition) + .footnote-definition,
|
||||||
|
.footnote-definition + :not(.footnote-definition) {
|
||||||
|
margin-top: 2em;
|
||||||
|
}
|
||||||
|
.footnote-definition {
|
||||||
|
font-size: 0.9em;
|
||||||
|
margin: 0.5em 0;
|
||||||
|
}
|
||||||
|
.footnote-definition p {
|
||||||
|
display: inline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tooltiptext {
|
||||||
|
position: absolute;
|
||||||
|
visibility: hidden;
|
||||||
|
color: #fff;
|
||||||
|
background-color: #333;
|
||||||
|
transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
|
||||||
|
left: -8px; /* Half of the width of the icon */
|
||||||
|
top: -35px;
|
||||||
|
font-size: 0.8em;
|
||||||
|
text-align: center;
|
||||||
|
border-radius: 6px;
|
||||||
|
padding: 5px 8px;
|
||||||
|
margin: 5px;
|
||||||
|
z-index: 1000;
|
||||||
|
}
|
||||||
|
.tooltipped .tooltiptext {
|
||||||
|
visibility: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.part-title {
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
margin: 5px 0px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
54
0.1.0/css/print.css
Normal file
54
0.1.0/css/print.css
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
|
||||||
|
#sidebar,
|
||||||
|
#menu-bar,
|
||||||
|
.nav-chapters,
|
||||||
|
.mobile-nav-chapters {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#page-wrapper.page-wrapper {
|
||||||
|
transform: none;
|
||||||
|
margin-left: 0px;
|
||||||
|
overflow-y: initial;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
max-width: none;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page {
|
||||||
|
overflow-y: initial;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
background-color: #666666;
|
||||||
|
border-radius: 5px;
|
||||||
|
|
||||||
|
/* Force background to be printed in Chrome */
|
||||||
|
-webkit-print-color-adjust: exact;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre > .buttons {
|
||||||
|
z-index: 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
a, a:visited, a:active, a:hover {
|
||||||
|
color: #4183c4;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
page-break-inside: avoid;
|
||||||
|
page-break-after: avoid;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre, code {
|
||||||
|
page-break-inside: avoid;
|
||||||
|
white-space: pre-wrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fa {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
253
0.1.0/css/variables.css
Normal file
253
0.1.0/css/variables.css
Normal file
|
|
@ -0,0 +1,253 @@
|
||||||
|
|
||||||
|
/* Globals */
|
||||||
|
|
||||||
|
:root {
|
||||||
|
--sidebar-width: 300px;
|
||||||
|
--page-padding: 15px;
|
||||||
|
--content-max-width: 750px;
|
||||||
|
--menu-bar-height: 50px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Themes */
|
||||||
|
|
||||||
|
.ayu {
|
||||||
|
--bg: hsl(210, 25%, 8%);
|
||||||
|
--fg: #c5c5c5;
|
||||||
|
|
||||||
|
--sidebar-bg: #14191f;
|
||||||
|
--sidebar-fg: #c8c9db;
|
||||||
|
--sidebar-non-existant: #5c6773;
|
||||||
|
--sidebar-active: #ffb454;
|
||||||
|
--sidebar-spacer: #2d334f;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #737480;
|
||||||
|
--icons-hover: #b7b9cc;
|
||||||
|
|
||||||
|
--links: #0096cf;
|
||||||
|
|
||||||
|
--inline-code-color: #ffb454;
|
||||||
|
|
||||||
|
--theme-popup-bg: #14191f;
|
||||||
|
--theme-popup-border: #5c6773;
|
||||||
|
--theme-hover: #191f26;
|
||||||
|
|
||||||
|
--quote-bg: hsl(226, 15%, 17%);
|
||||||
|
--quote-border: hsl(226, 15%, 22%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(210, 25%, 13%);
|
||||||
|
--table-header-bg: hsl(210, 25%, 28%);
|
||||||
|
--table-alternate-bg: hsl(210, 25%, 11%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #848484;
|
||||||
|
--searchbar-bg: #424242;
|
||||||
|
--searchbar-fg: #fff;
|
||||||
|
--searchbar-shadow-color: #d4c89f;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #888;
|
||||||
|
--searchresults-li-bg: #252932;
|
||||||
|
--search-mark-bg: #e3b171;
|
||||||
|
}
|
||||||
|
|
||||||
|
.coal {
|
||||||
|
--bg: hsl(200, 7%, 8%);
|
||||||
|
--fg: #98a3ad;
|
||||||
|
|
||||||
|
--sidebar-bg: #292c2f;
|
||||||
|
--sidebar-fg: #a1adb8;
|
||||||
|
--sidebar-non-existant: #505254;
|
||||||
|
--sidebar-active: #3473ad;
|
||||||
|
--sidebar-spacer: #393939;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #43484d;
|
||||||
|
--icons-hover: #b3c0cc;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #c5c8c6;;
|
||||||
|
|
||||||
|
--theme-popup-bg: #141617;
|
||||||
|
--theme-popup-border: #43484d;
|
||||||
|
--theme-hover: #1f2124;
|
||||||
|
|
||||||
|
--quote-bg: hsl(234, 21%, 18%);
|
||||||
|
--quote-border: hsl(234, 21%, 23%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(200, 7%, 13%);
|
||||||
|
--table-header-bg: hsl(200, 7%, 28%);
|
||||||
|
--table-alternate-bg: hsl(200, 7%, 11%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #b7b7b7;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #98a3ad;
|
||||||
|
--searchresults-li-bg: #2b2b2f;
|
||||||
|
--search-mark-bg: #355c7d;
|
||||||
|
}
|
||||||
|
|
||||||
|
.light {
|
||||||
|
--bg: hsl(0, 0%, 100%);
|
||||||
|
--fg: hsl(0, 0%, 0%);
|
||||||
|
|
||||||
|
--sidebar-bg: #fafafa;
|
||||||
|
--sidebar-fg: hsl(0, 0%, 0%);
|
||||||
|
--sidebar-non-existant: #aaaaaa;
|
||||||
|
--sidebar-active: #1f1fff;
|
||||||
|
--sidebar-spacer: #f4f4f4;
|
||||||
|
|
||||||
|
--scrollbar: #8F8F8F;
|
||||||
|
|
||||||
|
--icons: #747474;
|
||||||
|
--icons-hover: #000000;
|
||||||
|
|
||||||
|
--links: #20609f;
|
||||||
|
|
||||||
|
--inline-code-color: #301900;
|
||||||
|
|
||||||
|
--theme-popup-bg: #fafafa;
|
||||||
|
--theme-popup-border: #cccccc;
|
||||||
|
--theme-hover: #e6e6e6;
|
||||||
|
|
||||||
|
--quote-bg: hsl(197, 37%, 96%);
|
||||||
|
--quote-border: hsl(197, 37%, 91%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(0, 0%, 95%);
|
||||||
|
--table-header-bg: hsl(0, 0%, 80%);
|
||||||
|
--table-alternate-bg: hsl(0, 0%, 97%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #fafafa;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #888;
|
||||||
|
--searchresults-li-bg: #e4f2fe;
|
||||||
|
--search-mark-bg: #a2cff5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navy {
|
||||||
|
--bg: hsl(226, 23%, 11%);
|
||||||
|
--fg: #bcbdd0;
|
||||||
|
|
||||||
|
--sidebar-bg: #282d3f;
|
||||||
|
--sidebar-fg: #c8c9db;
|
||||||
|
--sidebar-non-existant: #505274;
|
||||||
|
--sidebar-active: #2b79a2;
|
||||||
|
--sidebar-spacer: #2d334f;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #737480;
|
||||||
|
--icons-hover: #b7b9cc;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #c5c8c6;;
|
||||||
|
|
||||||
|
--theme-popup-bg: #161923;
|
||||||
|
--theme-popup-border: #737480;
|
||||||
|
--theme-hover: #282e40;
|
||||||
|
|
||||||
|
--quote-bg: hsl(226, 15%, 17%);
|
||||||
|
--quote-border: hsl(226, 15%, 22%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(226, 23%, 16%);
|
||||||
|
--table-header-bg: hsl(226, 23%, 31%);
|
||||||
|
--table-alternate-bg: hsl(226, 23%, 14%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #aeaec6;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #5f5f71;
|
||||||
|
--searchresults-border-color: #5c5c68;
|
||||||
|
--searchresults-li-bg: #242430;
|
||||||
|
--search-mark-bg: #a2cff5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rust {
|
||||||
|
--bg: hsl(60, 9%, 87%);
|
||||||
|
--fg: #262625;
|
||||||
|
|
||||||
|
--sidebar-bg: #3b2e2a;
|
||||||
|
--sidebar-fg: #c8c9db;
|
||||||
|
--sidebar-non-existant: #505254;
|
||||||
|
--sidebar-active: #e69f67;
|
||||||
|
--sidebar-spacer: #45373a;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #737480;
|
||||||
|
--icons-hover: #262625;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #6e6b5e;
|
||||||
|
|
||||||
|
--theme-popup-bg: #e1e1db;
|
||||||
|
--theme-popup-border: #b38f6b;
|
||||||
|
--theme-hover: #99908a;
|
||||||
|
|
||||||
|
--quote-bg: hsl(60, 5%, 75%);
|
||||||
|
--quote-border: hsl(60, 5%, 70%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(60, 9%, 82%);
|
||||||
|
--table-header-bg: #b3a497;
|
||||||
|
--table-alternate-bg: hsl(60, 9%, 84%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #fafafa;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #888;
|
||||||
|
--searchresults-li-bg: #dec2a2;
|
||||||
|
--search-mark-bg: #e69f67;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
.light.no-js {
|
||||||
|
--bg: hsl(200, 7%, 8%);
|
||||||
|
--fg: #98a3ad;
|
||||||
|
|
||||||
|
--sidebar-bg: #292c2f;
|
||||||
|
--sidebar-fg: #a1adb8;
|
||||||
|
--sidebar-non-existant: #505254;
|
||||||
|
--sidebar-active: #3473ad;
|
||||||
|
--sidebar-spacer: #393939;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #43484d;
|
||||||
|
--icons-hover: #b3c0cc;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #c5c8c6;;
|
||||||
|
|
||||||
|
--theme-popup-bg: #141617;
|
||||||
|
--theme-popup-border: #43484d;
|
||||||
|
--theme-hover: #1f2124;
|
||||||
|
|
||||||
|
--quote-bg: hsl(234, 21%, 18%);
|
||||||
|
--quote-border: hsl(234, 21%, 23%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(200, 7%, 13%);
|
||||||
|
--table-header-bg: hsl(200, 7%, 28%);
|
||||||
|
--table-alternate-bg: hsl(200, 7%, 11%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #b7b7b7;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #98a3ad;
|
||||||
|
--searchresults-li-bg: #2b2b2f;
|
||||||
|
--search-mark-bg: #355c7d;
|
||||||
|
}
|
||||||
|
}
|
||||||
10
0.1.0/elasticlunr.min.js
vendored
Normal file
10
0.1.0/elasticlunr.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
BIN
0.1.0/favicon.png
Normal file
BIN
0.1.0/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.5 KiB |
22
0.1.0/favicon.svg
Normal file
22
0.1.0/favicon.svg
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 199.7 184.2">
|
||||||
|
<style>
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
svg { fill: white; }
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<path d="M189.5,36.8c0.2,2.8,0,5.1-0.6,6.8L153,162c-0.6,2.1-2,3.7-4.2,5c-2.2,1.2-4.4,1.9-6.7,1.9H31.4c-9.6,0-15.3-2.8-17.3-8.4
|
||||||
|
c-0.8-2.2-0.8-3.9,0.1-5.2c0.9-1.2,2.4-1.8,4.6-1.8H123c7.4,0,12.6-1.4,15.4-4.1s5.7-8.9,8.6-18.4l32.9-108.6
|
||||||
|
c1.8-5.9,1-11.1-2.2-15.6S169.9,0,164,0H72.7c-1,0-3.1,0.4-6.1,1.1l0.1-0.4C64.5,0.2,62.6,0,61,0.1s-3,0.5-4.3,1.4
|
||||||
|
c-1.3,0.9-2.4,1.8-3.2,2.8S52,6.5,51.2,8.1c-0.8,1.6-1.4,3-1.9,4.3s-1.1,2.7-1.8,4.2c-0.7,1.5-1.3,2.7-2,3.7c-0.5,0.6-1.2,1.5-2,2.5
|
||||||
|
s-1.6,2-2.2,2.8s-0.9,1.5-1.1,2.2c-0.2,0.7-0.1,1.8,0.2,3.2c0.3,1.4,0.4,2.4,0.4,3.1c-0.3,3-1.4,6.9-3.3,11.6
|
||||||
|
c-1.9,4.7-3.6,8.1-5.1,10.1c-0.3,0.4-1.2,1.3-2.6,2.7c-1.4,1.4-2.3,2.6-2.6,3.7c-0.3,0.4-0.3,1.5-0.1,3.4c0.3,1.8,0.4,3.1,0.3,3.8
|
||||||
|
c-0.3,2.7-1.3,6.3-3,10.8c-1.7,4.5-3.4,8.2-5,11c-0.2,0.5-0.9,1.4-2,2.8c-1.1,1.4-1.8,2.5-2,3.4c-0.2,0.6-0.1,1.8,0.1,3.4
|
||||||
|
c0.2,1.6,0.2,2.8-0.1,3.6c-0.6,3-1.8,6.7-3.6,11c-1.8,4.3-3.6,7.9-5.4,11c-0.5,0.8-1.1,1.7-2,2.8c-0.8,1.1-1.5,2-2,2.8
|
||||||
|
s-0.8,1.6-1,2.5c-0.1,0.5,0,1.3,0.4,2.3c0.3,1.1,0.4,1.9,0.4,2.6c-0.1,1.1-0.2,2.6-0.5,4.4c-0.2,1.8-0.4,2.9-0.4,3.2
|
||||||
|
c-1.8,4.8-1.7,9.9,0.2,15.2c2.2,6.2,6.2,11.5,11.9,15.8c5.7,4.3,11.7,6.4,17.8,6.4h110.7c5.2,0,10.1-1.7,14.7-5.2s7.7-7.8,9.2-12.9
|
||||||
|
l33-108.6c1.8-5.8,1-10.9-2.2-15.5C194.9,39.7,192.6,38,189.5,36.8z M59.6,122.8L73.8,80c0,0,7,0,10.8,0s28.8-1.7,25.4,17.5
|
||||||
|
c-3.4,19.2-18.8,25.2-36.8,25.4S59.6,122.8,59.6,122.8z M78.6,116.8c4.7-0.1,18.9-2.9,22.1-17.1S89.2,86.3,89.2,86.3l-8.9,0
|
||||||
|
l-10.2,30.5C70.2,116.9,74,116.9,78.6,116.8z M75.3,68.7L89,26.2h9.8l0.8,34l23.6-34h9.9l-13.6,42.5h-7.1l12.5-35.4l-24.5,35.4h-6.8
|
||||||
|
l-0.8-35L82,68.7H75.3z"/>
|
||||||
|
</svg>
|
||||||
|
<!-- Original image Copyright Dave Gandy — CC BY 4.0 License -->
|
||||||
|
After Width: | Height: | Size: 1.8 KiB |
202
0.1.0/fonts/OPEN-SANS-LICENSE.txt
Normal file
202
0.1.0/fonts/OPEN-SANS-LICENSE.txt
Normal file
|
|
@ -0,0 +1,202 @@
|
||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
93
0.1.0/fonts/SOURCE-CODE-PRO-LICENSE.txt
Normal file
93
0.1.0/fonts/SOURCE-CODE-PRO-LICENSE.txt
Normal file
|
|
@ -0,0 +1,93 @@
|
||||||
|
Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
|
||||||
|
|
||||||
|
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||||
|
This license is copied below, and is also available with a FAQ at:
|
||||||
|
http://scripts.sil.org/OFL
|
||||||
|
|
||||||
|
|
||||||
|
-----------------------------------------------------------
|
||||||
|
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||||
|
-----------------------------------------------------------
|
||||||
|
|
||||||
|
PREAMBLE
|
||||||
|
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||||
|
development of collaborative font projects, to support the font creation
|
||||||
|
efforts of academic and linguistic communities, and to provide a free and
|
||||||
|
open framework in which fonts may be shared and improved in partnership
|
||||||
|
with others.
|
||||||
|
|
||||||
|
The OFL allows the licensed fonts to be used, studied, modified and
|
||||||
|
redistributed freely as long as they are not sold by themselves. The
|
||||||
|
fonts, including any derivative works, can be bundled, embedded,
|
||||||
|
redistributed and/or sold with any software provided that any reserved
|
||||||
|
names are not used by derivative works. The fonts and derivatives,
|
||||||
|
however, cannot be released under any other type of license. The
|
||||||
|
requirement for fonts to remain under this license does not apply
|
||||||
|
to any document created using the fonts or their derivatives.
|
||||||
|
|
||||||
|
DEFINITIONS
|
||||||
|
"Font Software" refers to the set of files released by the Copyright
|
||||||
|
Holder(s) under this license and clearly marked as such. This may
|
||||||
|
include source files, build scripts and documentation.
|
||||||
|
|
||||||
|
"Reserved Font Name" refers to any names specified as such after the
|
||||||
|
copyright statement(s).
|
||||||
|
|
||||||
|
"Original Version" refers to the collection of Font Software components as
|
||||||
|
distributed by the Copyright Holder(s).
|
||||||
|
|
||||||
|
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||||
|
or substituting -- in part or in whole -- any of the components of the
|
||||||
|
Original Version, by changing formats or by porting the Font Software to a
|
||||||
|
new environment.
|
||||||
|
|
||||||
|
"Author" refers to any designer, engineer, programmer, technical
|
||||||
|
writer or other person who contributed to the Font Software.
|
||||||
|
|
||||||
|
PERMISSION & CONDITIONS
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
|
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||||
|
redistribute, and sell modified and unmodified copies of the Font
|
||||||
|
Software, subject to the following conditions:
|
||||||
|
|
||||||
|
1) Neither the Font Software nor any of its individual components,
|
||||||
|
in Original or Modified Versions, may be sold by itself.
|
||||||
|
|
||||||
|
2) Original or Modified Versions of the Font Software may be bundled,
|
||||||
|
redistributed and/or sold with any software, provided that each copy
|
||||||
|
contains the above copyright notice and this license. These can be
|
||||||
|
included either as stand-alone text files, human-readable headers or
|
||||||
|
in the appropriate machine-readable metadata fields within text or
|
||||||
|
binary files as long as those fields can be easily viewed by the user.
|
||||||
|
|
||||||
|
3) No Modified Version of the Font Software may use the Reserved Font
|
||||||
|
Name(s) unless explicit written permission is granted by the corresponding
|
||||||
|
Copyright Holder. This restriction only applies to the primary font name as
|
||||||
|
presented to the users.
|
||||||
|
|
||||||
|
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||||
|
Software shall not be used to promote, endorse or advertise any
|
||||||
|
Modified Version, except to acknowledge the contribution(s) of the
|
||||||
|
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||||
|
permission.
|
||||||
|
|
||||||
|
5) The Font Software, modified or unmodified, in part or in whole,
|
||||||
|
must be distributed entirely under this license, and must not be
|
||||||
|
distributed under any other license. The requirement for fonts to
|
||||||
|
remain under this license does not apply to any document created
|
||||||
|
using the Font Software.
|
||||||
|
|
||||||
|
TERMINATION
|
||||||
|
This license becomes null and void if any of the above conditions are
|
||||||
|
not met.
|
||||||
|
|
||||||
|
DISCLAIMER
|
||||||
|
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||||
|
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||||
|
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||||
|
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||||
|
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||||
100
0.1.0/fonts/fonts.css
Normal file
100
0.1.0/fonts/fonts.css
Normal file
|
|
@ -0,0 +1,100 @@
|
||||||
|
/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
|
||||||
|
/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
|
||||||
|
|
||||||
|
/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 300;
|
||||||
|
src: local('Open Sans Light'), local('OpenSans-Light'),
|
||||||
|
url('open-sans-v17-all-charsets-300.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 300;
|
||||||
|
src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
src: local('Open Sans Regular'), local('OpenSans-Regular'),
|
||||||
|
url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 400;
|
||||||
|
src: local('Open Sans Italic'), local('OpenSans-Italic'),
|
||||||
|
url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 600;
|
||||||
|
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
|
||||||
|
url('open-sans-v17-all-charsets-600.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 600;
|
||||||
|
src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 700;
|
||||||
|
src: local('Open Sans Bold'), local('OpenSans-Bold'),
|
||||||
|
url('open-sans-v17-all-charsets-700.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 700;
|
||||||
|
src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 800;
|
||||||
|
src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
|
||||||
|
url('open-sans-v17-all-charsets-800.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 800;
|
||||||
|
src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Source Code Pro';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 500;
|
||||||
|
src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
|
||||||
|
}
|
||||||
BIN
0.1.0/fonts/open-sans-v17-all-charsets-300.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-300.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-300italic.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-300italic.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-600.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-600.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-600italic.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-600italic.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-700.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-700.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-700italic.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-700italic.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-800.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-800.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-800italic.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-800italic.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-italic.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-italic.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/open-sans-v17-all-charsets-regular.woff2
Normal file
BIN
0.1.0/fonts/open-sans-v17-all-charsets-regular.woff2
Normal file
Binary file not shown.
BIN
0.1.0/fonts/source-code-pro-v11-all-charsets-500.woff2
Normal file
BIN
0.1.0/fonts/source-code-pro-v11-all-charsets-500.woff2
Normal file
Binary file not shown.
83
0.1.0/highlight.css
Normal file
83
0.1.0/highlight.css
Normal file
|
|
@ -0,0 +1,83 @@
|
||||||
|
/*
|
||||||
|
* An increased contrast highlighting scheme loosely based on the
|
||||||
|
* "Base16 Atelier Dune Light" theme by Bram de Haan
|
||||||
|
* (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
|
||||||
|
* Original Base16 color scheme by Chris Kempson
|
||||||
|
* (https://github.com/chriskempson/base16)
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* Comment */
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-quote {
|
||||||
|
color: #575757;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Red */
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-tag,
|
||||||
|
.hljs-name,
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-link,
|
||||||
|
.hljs-name,
|
||||||
|
.hljs-selector-id,
|
||||||
|
.hljs-selector-class {
|
||||||
|
color: #d70025;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Orange */
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-meta,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-builtin-name,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-type,
|
||||||
|
.hljs-params {
|
||||||
|
color: #b21e00;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Green */
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-symbol,
|
||||||
|
.hljs-bullet {
|
||||||
|
color: #008200;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Blue */
|
||||||
|
.hljs-title,
|
||||||
|
.hljs-section {
|
||||||
|
color: #0030f2;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Purple */
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-selector-tag {
|
||||||
|
color: #9d00ec;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
background: #f6f7f6;
|
||||||
|
color: #000;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-emphasis {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
color: #22863a;
|
||||||
|
background-color: #f0fff4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
color: #b31d28;
|
||||||
|
background-color: #ffeef0;
|
||||||
|
}
|
||||||
6
0.1.0/highlight.js
Normal file
6
0.1.0/highlight.js
Normal file
File diff suppressed because one or more lines are too long
554
0.1.0/index.html
Normal file
554
0.1.0/index.html
Normal file
|
|
@ -0,0 +1,554 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>Rules ForeignCc - Rules ForeignCc</title>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html" class="active"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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="rules-foreign-cc"><a class="header" href="#rules-foreign-cc">Rules Foreign CC</a></h1>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#boost_build">boost_build</a></li>
|
||||||
|
<li><a href="#cmake_external">cmake_external</a></li>
|
||||||
|
<li><a href="#cmake_tool">cmake_tool</a></li>
|
||||||
|
<li><a href="#ConfigureParameters">ConfigureParameters</a></li>
|
||||||
|
<li><a href="#configure_make">configure_make</a></li>
|
||||||
|
<li><a href="#ForeignCcArtifact">ForeignCcArtifact</a></li>
|
||||||
|
<li><a href="#ForeignCcDeps">ForeignCcDeps</a></li>
|
||||||
|
<li><a href="#InputFiles">InputFiles</a></li>
|
||||||
|
<li><a href="#make">make</a></li>
|
||||||
|
<li><a href="#make_tool">make_tool</a></li>
|
||||||
|
<li><a href="#native_tool_toolchain">native_tool_toolchain</a></li>
|
||||||
|
<li><a href="#ninja">ninja</a></li>
|
||||||
|
<li><a href="#ninja_tool">ninja_tool</a></li>
|
||||||
|
<li><a href="#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></li>
|
||||||
|
<li><a href="#ToolInfo">ToolInfo</a></li>
|
||||||
|
<li><a href="#WrappedOutputs">WrappedOutputs</a></li>
|
||||||
|
</ul>
|
||||||
|
<p><a id="#boost_build"></a></p>
|
||||||
|
<h2 id="boost_build"><a class="header" href="#boost_build">boost_build</a></h2>
|
||||||
|
<pre>
|
||||||
|
boost_build(<a href="#boost_build-name">name</a>, <a href="#boost_build-additional_inputs">additional_inputs</a>, <a href="#boost_build-additional_tools">additional_tools</a>, <a href="#boost_build-alwayslink">alwayslink</a>, <a href="#boost_build-binaries">binaries</a>, <a href="#boost_build-bootstrap_options">bootstrap_options</a>,
|
||||||
|
<a href="#boost_build-data">data</a>, <a href="#boost_build-defines">defines</a>, <a href="#boost_build-deps">deps</a>, <a href="#boost_build-env">env</a>, <a href="#boost_build-headers_only">headers_only</a>, <a href="#boost_build-interface_libraries">interface_libraries</a>, <a href="#boost_build-lib_name">lib_name</a>, <a href="#boost_build-lib_source">lib_source</a>,
|
||||||
|
<a href="#boost_build-linkopts">linkopts</a>, <a href="#boost_build-make_commands">make_commands</a>, <a href="#boost_build-out_bin_dir">out_bin_dir</a>, <a href="#boost_build-out_include_dir">out_include_dir</a>, <a href="#boost_build-out_lib_dir">out_lib_dir</a>, <a href="#boost_build-postfix_script">postfix_script</a>,
|
||||||
|
<a href="#boost_build-shared_libraries">shared_libraries</a>, <a href="#boost_build-static_libraries">static_libraries</a>, <a href="#boost_build-tools_deps">tools_deps</a>, <a href="#boost_build-user_options">user_options</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Boost. Invokes bootstrap.sh and then b2 install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="boost_build-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-bootstrap_options"></a>bootstrap_options</td><td align="left">any additional flags to pass to bootstrap.sh</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-user_options"></a>user_options</td><td align="left">any additional flags to pass to b2</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake_external"></a></p>
|
||||||
|
<h2 id="cmake_external"><a class="header" href="#cmake_external">cmake_external</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake_external(<a href="#cmake_external-name">name</a>, <a href="#cmake_external-additional_inputs">additional_inputs</a>, <a href="#cmake_external-additional_tools">additional_tools</a>, <a href="#cmake_external-alwayslink">alwayslink</a>, <a href="#cmake_external-binaries">binaries</a>, <a href="#cmake_external-cache_entries">cache_entries</a>,
|
||||||
|
<a href="#cmake_external-cmake_options">cmake_options</a>, <a href="#cmake_external-data">data</a>, <a href="#cmake_external-defines">defines</a>, <a href="#cmake_external-deps">deps</a>, <a href="#cmake_external-env">env</a>, <a href="#cmake_external-env_vars">env_vars</a>, <a href="#cmake_external-generate_crosstool_file">generate_crosstool_file</a>,
|
||||||
|
<a href="#cmake_external-headers_only">headers_only</a>, <a href="#cmake_external-install_prefix">install_prefix</a>, <a href="#cmake_external-interface_libraries">interface_libraries</a>, <a href="#cmake_external-lib_name">lib_name</a>, <a href="#cmake_external-lib_source">lib_source</a>, <a href="#cmake_external-linkopts">linkopts</a>,
|
||||||
|
<a href="#cmake_external-make_commands">make_commands</a>, <a href="#cmake_external-out_bin_dir">out_bin_dir</a>, <a href="#cmake_external-out_include_dir">out_include_dir</a>, <a href="#cmake_external-out_lib_dir">out_lib_dir</a>, <a href="#cmake_external-postfix_script">postfix_script</a>,
|
||||||
|
<a href="#cmake_external-shared_libraries">shared_libraries</a>, <a href="#cmake_external-static_libraries">static_libraries</a>, <a href="#cmake_external-tools_deps">tools_deps</a>, <a href="#cmake_external-working_directory">working_directory</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external library with CMake.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake_external-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-cache_entries"></a>cache_entries</td><td align="left">CMake cache entries to initialize (they will be passed with -Dkey=value) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-cmake_options"></a>cmake_options</td><td align="left">Other CMake options</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-env_vars"></a>env_vars</td><td align="left">CMake environment variable values to join with toolchain-defined. For example, additional CXXFLAGS.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-generate_crosstool_file"></a>generate_crosstool_file</td><td align="left">When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as -Dkey=value and environment variables). If CMAKE_TOOLCHAIN_FILE cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify CMAKE_SYSTEM_NAME in the cache_entries</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-install_prefix"></a>install_prefix</td><td align="left">Relative install prefix to be passed to CMake in -DCMAKE_INSTALL_PREFIX</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-working_directory"></a>working_directory</td><td align="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake_tool"></a></p>
|
||||||
|
<h2 id="cmake_tool"><a class="header" href="#cmake_tool">cmake_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake_tool(<a href="#cmake_tool-name">name</a>, <a href="#cmake_tool-cmake_srcs">cmake_srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building CMake. Invokes bootstrap script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-cmake_srcs"></a>cmake_srcs</td><td align="left">-</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#configure_make"></a></p>
|
||||||
|
<h2 id="configure_make"><a class="header" href="#configure_make">configure_make</a></h2>
|
||||||
|
<pre>
|
||||||
|
configure_make(<a href="#configure_make-name">name</a>, <a href="#configure_make-additional_inputs">additional_inputs</a>, <a href="#configure_make-additional_tools">additional_tools</a>, <a href="#configure_make-alwayslink">alwayslink</a>, <a href="#configure_make-autoconf">autoconf</a>, <a href="#configure_make-autoconf_env_vars">autoconf_env_vars</a>,
|
||||||
|
<a href="#configure_make-autoconf_options">autoconf_options</a>, <a href="#configure_make-autogen">autogen</a>, <a href="#configure_make-autogen_command">autogen_command</a>, <a href="#configure_make-autogen_env_vars">autogen_env_vars</a>, <a href="#configure_make-autogen_options">autogen_options</a>,
|
||||||
|
<a href="#configure_make-autoreconf">autoreconf</a>, <a href="#configure_make-autoreconf_env_vars">autoreconf_env_vars</a>, <a href="#configure_make-autoreconf_options">autoreconf_options</a>, <a href="#configure_make-binaries">binaries</a>, <a href="#configure_make-configure_command">configure_command</a>,
|
||||||
|
<a href="#configure_make-configure_env_vars">configure_env_vars</a>, <a href="#configure_make-configure_in_place">configure_in_place</a>, <a href="#configure_make-configure_options">configure_options</a>, <a href="#configure_make-data">data</a>, <a href="#configure_make-defines">defines</a>, <a href="#configure_make-deps">deps</a>, <a href="#configure_make-env">env</a>,
|
||||||
|
<a href="#configure_make-headers_only">headers_only</a>, <a href="#configure_make-install_prefix">install_prefix</a>, <a href="#configure_make-interface_libraries">interface_libraries</a>, <a href="#configure_make-lib_name">lib_name</a>, <a href="#configure_make-lib_source">lib_source</a>, <a href="#configure_make-linkopts">linkopts</a>,
|
||||||
|
<a href="#configure_make-make_commands">make_commands</a>, <a href="#configure_make-out_bin_dir">out_bin_dir</a>, <a href="#configure_make-out_include_dir">out_include_dir</a>, <a href="#configure_make-out_lib_dir">out_lib_dir</a>, <a href="#configure_make-postfix_script">postfix_script</a>,
|
||||||
|
<a href="#configure_make-shared_libraries">shared_libraries</a>, <a href="#configure_make-static_libraries">static_libraries</a>, <a href="#configure_make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="configure_make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf"></a>autoconf</td><td align="left">Set to True if 'autoconf' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_env_vars"></a>autoconf_env_vars</td><td align="left">Environment variables to be set for 'autoconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_options"></a>autoconf_options</td><td align="left">Any options to be put in the 'autoconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen"></a>autogen</td><td align="left">Set to True if 'autogen.sh' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_command"></a>autogen_command</td><td align="left">The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.</td><td align="left">String</td><td align="left">optional</td><td align="left">"autogen.sh"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_env_vars"></a>autogen_env_vars</td><td align="left">Environment variables to be set for 'autogen' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_options"></a>autogen_options</td><td align="left">Any options to be put in the 'autogen.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf"></a>autoreconf</td><td align="left">Set to True if 'autoreconf' should be invoked before 'configure.', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_env_vars"></a>autoreconf_env_vars</td><td align="left">Environment variables to be set for 'autoreconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_options"></a>autoreconf_options</td><td align="left">Any options to be put in the 'autoreconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_command"></a>configure_command</td><td align="left">The name of the configuration script file, default: configure. The file must be in the root of the source directory.</td><td align="left">String</td><td align="left">optional</td><td align="left">"configure"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_env_vars"></a>configure_env_vars</td><td align="left">Environment variables to be set for the 'configure' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_in_place"></a>configure_in_place</td><td align="left">Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_options"></a>configure_options</td><td align="left">Any options to be put on the 'configure' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make"></a></p>
|
||||||
|
<h2 id="make"><a class="header" href="#make">make</a></h2>
|
||||||
|
<pre>
|
||||||
|
make(<a href="#make-name">name</a>, <a href="#make-additional_inputs">additional_inputs</a>, <a href="#make-additional_tools">additional_tools</a>, <a href="#make-alwayslink">alwayslink</a>, <a href="#make-binaries">binaries</a>, <a href="#make-data">data</a>, <a href="#make-defines">defines</a>, <a href="#make-deps">deps</a>, <a href="#make-env">env</a>,
|
||||||
|
<a href="#make-headers_only">headers_only</a>, <a href="#make-interface_libraries">interface_libraries</a>, <a href="#make-keep_going">keep_going</a>, <a href="#make-lib_name">lib_name</a>, <a href="#make-lib_source">lib_source</a>, <a href="#make-linkopts">linkopts</a>, <a href="#make-make_commands">make_commands</a>,
|
||||||
|
<a href="#make-make_env_vars">make_env_vars</a>, <a href="#make-out_bin_dir">out_bin_dir</a>, <a href="#make-out_include_dir">out_include_dir</a>, <a href="#make-out_lib_dir">out_lib_dir</a>, <a href="#make-postfix_script">postfix_script</a>, <a href="#make-prefix">prefix</a>,
|
||||||
|
<a href="#make-shared_libraries">shared_libraries</a>, <a href="#make-static_libraries">static_libraries</a>, <a href="#make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with prefix="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-keep_going"></a>keep_going</td><td align="left">Keep going when some targets can not be made, -k flag is passed to make (applies only if make_commands attribute is not set). Please have a look at _create_make_script for default make_commands.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_commands"></a>make_commands</td><td align="left">Overriding make_commands default value to be empty, then we can provide better default value programmatically</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_env_vars"></a>make_env_vars</td><td align="left">Environment variables to be set for the 'configure' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-prefix"></a>prefix</td><td align="left">Install prefix, an absolute path. Passed to the GNU make via "make install PREFIX=<value>". By default, the install directory created under sandboxed execution root is used. Build results are copied to the Bazel's output directory, so the prefix is only important if it is recorded into any text files by Makefile script. In that case, it is important to note that rules_foreign_cc is overriding the paths under execution root with "BAZEL_GEN_ROOT" value.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make_tool"></a></p>
|
||||||
|
<h2 id="make_tool"><a class="header" href="#make_tool">make_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
make_tool(<a href="#make_tool-name">name</a>, <a href="#make_tool-make_srcs">make_srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Make. Invokes configure script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make_tool-make_srcs"></a>make_srcs</td><td align="left">target with the Make sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#native_tool_toolchain"></a></p>
|
||||||
|
<h2 id="native_tool_toolchain"><a class="header" href="#native_tool_toolchain">native_tool_toolchain</a></h2>
|
||||||
|
<pre>
|
||||||
|
native_tool_toolchain(<a href="#native_tool_toolchain-name">name</a>, <a href="#native_tool_toolchain-path">path</a>, <a href="#native_tool_toolchain-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types <code>@rules_foreign_cc//tools/build_defs:cmake_toolchain</code> and <code>@rules_foreign_cc//tools/build_defs:ninja_toolchain</code>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">optional</td><td align="left">None</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja"></a></p>
|
||||||
|
<h2 id="ninja"><a class="header" href="#ninja">ninja</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja(<a href="#ninja-name">name</a>, <a href="#ninja-additional_inputs">additional_inputs</a>, <a href="#ninja-additional_tools">additional_tools</a>, <a href="#ninja-alwayslink">alwayslink</a>, <a href="#ninja-args">args</a>, <a href="#ninja-binaries">binaries</a>, <a href="#ninja-data">data</a>, <a href="#ninja-defines">defines</a>, <a href="#ninja-deps">deps</a>,
|
||||||
|
<a href="#ninja-directory">directory</a>, <a href="#ninja-env">env</a>, <a href="#ninja-headers_only">headers_only</a>, <a href="#ninja-interface_libraries">interface_libraries</a>, <a href="#ninja-lib_name">lib_name</a>, <a href="#ninja-lib_source">lib_source</a>, <a href="#ninja-linkopts">linkopts</a>, <a href="#ninja-out_bin_dir">out_bin_dir</a>,
|
||||||
|
<a href="#ninja-out_include_dir">out_include_dir</a>, <a href="#ninja-out_lib_dir">out_lib_dir</a>, <a href="#ninja-postfix_script">postfix_script</a>, <a href="#ninja-shared_libraries">shared_libraries</a>, <a href="#ninja-static_libraries">static_libraries</a>, <a href="#ninja-targets">targets</a>,
|
||||||
|
<a href="#ninja-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with <a href="https://ninja-build.org/">Ninja</a>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>ninja</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-directory"></a>directory</td><td align="left">A directory to pass as the <code>-C</code> argument. The rule will always use the root directory of the <code>lib_sources</code> attribute if this attribute is not set</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-targets"></a>targets</td><td align="left">A list of ninja targets to build. To call the default target, simply pass <code>""</code> as one of the items to this attribute.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja_tool"></a></p>
|
||||||
|
<h2 id="ninja_tool"><a class="header" href="#ninja_tool">ninja_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja_tool(<a href="#ninja_tool-name">name</a>, <a href="#ninja_tool-ninja_srcs">ninja_srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Ninja. Invokes configure script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-ninja_srcs"></a>ninja_srcs</td><td align="left">-</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ConfigureParameters"></a></p>
|
||||||
|
<h2 id="configureparameters"><a class="header" href="#configureparameters">ConfigureParameters</a></h2>
|
||||||
|
<pre>
|
||||||
|
ConfigureParameters(<a href="#ConfigureParameters-ctx">ctx</a>, <a href="#ConfigureParameters-attrs">attrs</a>, <a href="#ConfigureParameters-inputs">inputs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Parameters of create_configure_script callback function, called by
|
||||||
|
cc_external_rule_impl function. create_configure_script creates the configuration part
|
||||||
|
of the script, and allows to reuse the inputs structure, created by the framework.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ConfigureParameters-ctx"></a>ctx</td><td align="left">Rule context</td></tr>
|
||||||
|
<tr><td align="left"><a id="ConfigureParameters-attrs"></a>attrs</td><td align="left">Attributes struct, created by create_attrs function above</td></tr>
|
||||||
|
<tr><td align="left"><a id="ConfigureParameters-inputs"></a>inputs</td><td align="left">InputFiles provider: summarized information on rule inputs, created by framework function, to be reused in script creator. Contains in particular merged compilation and linking dependencies.</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcArtifact"></a></p>
|
||||||
|
<h2 id="foreignccartifact"><a class="header" href="#foreignccartifact">ForeignCcArtifact</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcArtifact(<a href="#ForeignCcArtifact-bin_dir_name">bin_dir_name</a>, <a href="#ForeignCcArtifact-gen_dir">gen_dir</a>, <a href="#ForeignCcArtifact-include_dir_name">include_dir_name</a>, <a href="#ForeignCcArtifact-lib_dir_name">lib_dir_name</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Groups information about the external library install directory,
|
||||||
|
and relative bin, include and lib directories.</p>
|
||||||
|
<p>Serves to pass transitive information about externally built artifacts up the dependency chain.</p>
|
||||||
|
<p>Can not be used as a top-level provider.
|
||||||
|
Instances of ForeignCcArtifact are incapsulated in a depset ForeignCcDeps#artifacts.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-bin_dir_name"></a>bin_dir_name</td><td align="left">Bin directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-gen_dir"></a>gen_dir</td><td align="left">Install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-include_dir_name"></a>include_dir_name</td><td align="left">Include directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-lib_dir_name"></a>lib_dir_name</td><td align="left">Lib directory, relative to install directory</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcDeps"></a></p>
|
||||||
|
<h2 id="foreignccdeps"><a class="header" href="#foreignccdeps">ForeignCcDeps</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcDeps(<a href="#ForeignCcDeps-artifacts">artifacts</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Provider to pass transitive information about external libraries.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcDeps-artifacts"></a>artifacts</td><td align="left">Depset of ForeignCcArtifact</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#InputFiles"></a></p>
|
||||||
|
<h2 id="inputfiles"><a class="header" href="#inputfiles">InputFiles</a></h2>
|
||||||
|
<pre>
|
||||||
|
InputFiles(<a href="#InputFiles-headers">headers</a>, <a href="#InputFiles-include_dirs">include_dirs</a>, <a href="#InputFiles-libs">libs</a>, <a href="#InputFiles-tools_files">tools_files</a>, <a href="#InputFiles-ext_build_dirs">ext_build_dirs</a>, <a href="#InputFiles-deps_compilation_info">deps_compilation_info</a>,
|
||||||
|
<a href="#InputFiles-deps_linking_info">deps_linking_info</a>, <a href="#InputFiles-declared_inputs">declared_inputs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Provider to keep different kinds of input files, directories, and C/C++ compilation and linking info from dependencies</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="InputFiles-headers"></a>headers</td><td align="left">Include files built by Bazel. Will be copied into $EXT_BUILD_DEPS/include.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-include_dirs"></a>include_dirs</td><td align="left">Include directories built by Bazel. Will be copied into $EXT_BUILD_DEPS/include.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-libs"></a>libs</td><td align="left">Library files built by Bazel. Will be copied into $EXT_BUILD_DEPS/lib.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-tools_files"></a>tools_files</td><td align="left">Files and directories with tools needed for configuration/building to be copied into the bin folder, which is added to the PATH</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-ext_build_dirs"></a>ext_build_dirs</td><td align="left">Directories with libraries, built by framework function. This directories should be copied into $EXT_BUILD_DEPS/lib-name as is, with all contents.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-deps_compilation_info"></a>deps_compilation_info</td><td align="left">Merged CcCompilationInfo from deps attribute</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-deps_linking_info"></a>deps_linking_info</td><td align="left">Merged CcLinkingInfo from deps attribute</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-declared_inputs"></a>declared_inputs</td><td align="left">All files and directories that must be declared as action inputs</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ToolInfo"></a></p>
|
||||||
|
<h2 id="toolinfo"><a class="header" href="#toolinfo">ToolInfo</a></h2>
|
||||||
|
<pre>
|
||||||
|
ToolInfo(<a href="#ToolInfo-path">path</a>, <a href="#ToolInfo-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Information about the native tool</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td></tr>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#WrappedOutputs"></a></p>
|
||||||
|
<h2 id="wrappedoutputs"><a class="header" href="#wrappedoutputs">WrappedOutputs</a></h2>
|
||||||
|
<pre>
|
||||||
|
WrappedOutputs(<a href="#WrappedOutputs-log_file">log_file</a>, <a href="#WrappedOutputs-script_file">script_file</a>, <a href="#WrappedOutputs-wrapper_script">wrapper_script</a>, <a href="#WrappedOutputs-wrapper_script_file">wrapper_script_file</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Structure for passing the log and scripts file information, and wrapper script text.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-log_file"></a>log_file</td><td align="left">Execution log file</td></tr>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-script_file"></a>script_file</td><td align="left">Main script file</td></tr>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-wrapper_script"></a>wrapper_script</td><td align="left">Wrapper script text to execute</td></tr>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-wrapper_script_file"></a>wrapper_script_file</td><td align="left">Wrapper script file (output for debugging purposes)</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#rules_foreign_cc_dependencies"></a></p>
|
||||||
|
<h2 id="rules_foreign_cc_dependencies"><a class="header" href="#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></h2>
|
||||||
|
<pre>
|
||||||
|
rules_foreign_cc_dependencies(<a href="#rules_foreign_cc_dependencies-native_tools_toolchains">native_tools_toolchains</a>, <a href="#rules_foreign_cc_dependencies-register_default_tools">register_default_tools</a>, <a href="#rules_foreign_cc_dependencies-cmake_version">cmake_version</a>,
|
||||||
|
<a href="#rules_foreign_cc_dependencies-ninja_version">ninja_version</a>, <a href="#rules_foreign_cc_dependencies-register_preinstalled_tools">register_preinstalled_tools</a>,
|
||||||
|
<a href="#rules_foreign_cc_dependencies-additional_shell_toolchain_mappings">additional_shell_toolchain_mappings</a>, <a href="#rules_foreign_cc_dependencies-additional_shell_toolchain_package">additional_shell_toolchain_package</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Call this function from the WORKSPACE file to initialize rules_foreign_cc dependencies and let neccesary code generation happen (Code generation is needed to support different variants of the C++ Starlark API.).</p>
|
||||||
|
<p><strong>PARAMETERS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-native_tools_toolchains"></a>native_tools_toolchains</td><td align="left">pass the toolchains for toolchain types '@rules_foreign_cc//tools/build_defs:cmake_toolchain' and '@rules_foreign_cc//tools/build_defs:ninja_toolchain' with the needed platform constraints. If you do not pass anything, registered default toolchains will be selected (see below).</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_default_tools"></a>register_default_tools</td><td align="left">If True, the cmake and ninja toolchains, calling corresponding preinstalled binaries by name (cmake, ninja) will be registered after 'native_tools_toolchains' without any platform constraints. The default is True.</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-cmake_version"></a>cmake_version</td><td align="left">The target version of the default cmake toolchain if <code>register_default_tools</code> is set to <code>True</code>.</td><td align="left"><code>"3.19.6"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-ninja_version"></a>ninja_version</td><td align="left">The target version of the default ninja toolchain if <code>register_default_tools</code> is set to <code>True</code>.</td><td align="left"><code>"1.10.2"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_preinstalled_tools"></a>register_preinstalled_tools</td><td align="left">If true, toolchains will be registered for the native built tools installed on the exec host</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_mappings"></a>additional_shell_toolchain_mappings</td><td align="left">Mappings of the shell toolchain functions to execution and target platforms constraints. Similar to what defined in @rules_foreign_cc//tools/build_defs/shell_toolchain/toolchains:toolchain_mappings.bzl in the TOOLCHAIN_MAPPINGS list. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_package"></a>additional_shell_toolchain_package</td><td align="left">A package under which additional toolchains, referencing the generated data for the passed additonal_shell_toolchain_mappings, will be defined. This value is needed since register_toolchains() is called for these toolchains. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>None</code></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
|
||||||
|
|
||||||
|
<div style="clear: both"></div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
7
0.1.0/mark.min.js
vendored
Normal file
7
0.1.0/mark.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
560
0.1.0/print.html
Normal file
560
0.1.0/print.html
Normal file
|
|
@ -0,0 +1,560 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>Rules ForeignCc</title>
|
||||||
|
<meta name="robots" content="noindex" />
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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="rules-foreign-cc"><a class="header" href="#rules-foreign-cc">Rules Foreign CC</a></h1>
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#boost_build">boost_build</a></li>
|
||||||
|
<li><a href="index.html#cmake_external">cmake_external</a></li>
|
||||||
|
<li><a href="index.html#cmake_tool">cmake_tool</a></li>
|
||||||
|
<li><a href="index.html#ConfigureParameters">ConfigureParameters</a></li>
|
||||||
|
<li><a href="index.html#configure_make">configure_make</a></li>
|
||||||
|
<li><a href="index.html#ForeignCcArtifact">ForeignCcArtifact</a></li>
|
||||||
|
<li><a href="index.html#ForeignCcDeps">ForeignCcDeps</a></li>
|
||||||
|
<li><a href="index.html#InputFiles">InputFiles</a></li>
|
||||||
|
<li><a href="index.html#make">make</a></li>
|
||||||
|
<li><a href="index.html#make_tool">make_tool</a></li>
|
||||||
|
<li><a href="index.html#native_tool_toolchain">native_tool_toolchain</a></li>
|
||||||
|
<li><a href="index.html#ninja">ninja</a></li>
|
||||||
|
<li><a href="index.html#ninja_tool">ninja_tool</a></li>
|
||||||
|
<li><a href="index.html#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></li>
|
||||||
|
<li><a href="index.html#ToolInfo">ToolInfo</a></li>
|
||||||
|
<li><a href="index.html#WrappedOutputs">WrappedOutputs</a></li>
|
||||||
|
</ul>
|
||||||
|
<p><a id="#boost_build"></a></p>
|
||||||
|
<h2 id="boost_build"><a class="header" href="#boost_build">boost_build</a></h2>
|
||||||
|
<pre>
|
||||||
|
boost_build(<a href="index.html#boost_build-name">name</a>, <a href="index.html#boost_build-additional_inputs">additional_inputs</a>, <a href="index.html#boost_build-additional_tools">additional_tools</a>, <a href="index.html#boost_build-alwayslink">alwayslink</a>, <a href="index.html#boost_build-binaries">binaries</a>, <a href="index.html#boost_build-bootstrap_options">bootstrap_options</a>,
|
||||||
|
<a href="index.html#boost_build-data">data</a>, <a href="index.html#boost_build-defines">defines</a>, <a href="index.html#boost_build-deps">deps</a>, <a href="index.html#boost_build-env">env</a>, <a href="index.html#boost_build-headers_only">headers_only</a>, <a href="index.html#boost_build-interface_libraries">interface_libraries</a>, <a href="index.html#boost_build-lib_name">lib_name</a>, <a href="index.html#boost_build-lib_source">lib_source</a>,
|
||||||
|
<a href="index.html#boost_build-linkopts">linkopts</a>, <a href="index.html#boost_build-make_commands">make_commands</a>, <a href="index.html#boost_build-out_bin_dir">out_bin_dir</a>, <a href="index.html#boost_build-out_include_dir">out_include_dir</a>, <a href="index.html#boost_build-out_lib_dir">out_lib_dir</a>, <a href="index.html#boost_build-postfix_script">postfix_script</a>,
|
||||||
|
<a href="index.html#boost_build-shared_libraries">shared_libraries</a>, <a href="index.html#boost_build-static_libraries">static_libraries</a>, <a href="index.html#boost_build-tools_deps">tools_deps</a>, <a href="index.html#boost_build-user_options">user_options</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Boost. Invokes bootstrap.sh and then b2 install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="boost_build-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-bootstrap_options"></a>bootstrap_options</td><td align="left">any additional flags to pass to bootstrap.sh</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-user_options"></a>user_options</td><td align="left">any additional flags to pass to b2</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake_external"></a></p>
|
||||||
|
<h2 id="cmake_external"><a class="header" href="#cmake_external">cmake_external</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake_external(<a href="index.html#cmake_external-name">name</a>, <a href="index.html#cmake_external-additional_inputs">additional_inputs</a>, <a href="index.html#cmake_external-additional_tools">additional_tools</a>, <a href="index.html#cmake_external-alwayslink">alwayslink</a>, <a href="index.html#cmake_external-binaries">binaries</a>, <a href="index.html#cmake_external-cache_entries">cache_entries</a>,
|
||||||
|
<a href="index.html#cmake_external-cmake_options">cmake_options</a>, <a href="index.html#cmake_external-data">data</a>, <a href="index.html#cmake_external-defines">defines</a>, <a href="index.html#cmake_external-deps">deps</a>, <a href="index.html#cmake_external-env">env</a>, <a href="index.html#cmake_external-env_vars">env_vars</a>, <a href="index.html#cmake_external-generate_crosstool_file">generate_crosstool_file</a>,
|
||||||
|
<a href="index.html#cmake_external-headers_only">headers_only</a>, <a href="index.html#cmake_external-install_prefix">install_prefix</a>, <a href="index.html#cmake_external-interface_libraries">interface_libraries</a>, <a href="index.html#cmake_external-lib_name">lib_name</a>, <a href="index.html#cmake_external-lib_source">lib_source</a>, <a href="index.html#cmake_external-linkopts">linkopts</a>,
|
||||||
|
<a href="index.html#cmake_external-make_commands">make_commands</a>, <a href="index.html#cmake_external-out_bin_dir">out_bin_dir</a>, <a href="index.html#cmake_external-out_include_dir">out_include_dir</a>, <a href="index.html#cmake_external-out_lib_dir">out_lib_dir</a>, <a href="index.html#cmake_external-postfix_script">postfix_script</a>,
|
||||||
|
<a href="index.html#cmake_external-shared_libraries">shared_libraries</a>, <a href="index.html#cmake_external-static_libraries">static_libraries</a>, <a href="index.html#cmake_external-tools_deps">tools_deps</a>, <a href="index.html#cmake_external-working_directory">working_directory</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external library with CMake.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake_external-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-cache_entries"></a>cache_entries</td><td align="left">CMake cache entries to initialize (they will be passed with -Dkey=value) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-cmake_options"></a>cmake_options</td><td align="left">Other CMake options</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-env_vars"></a>env_vars</td><td align="left">CMake environment variable values to join with toolchain-defined. For example, additional CXXFLAGS.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-generate_crosstool_file"></a>generate_crosstool_file</td><td align="left">When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as -Dkey=value and environment variables). If CMAKE_TOOLCHAIN_FILE cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify CMAKE_SYSTEM_NAME in the cache_entries</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-install_prefix"></a>install_prefix</td><td align="left">Relative install prefix to be passed to CMake in -DCMAKE_INSTALL_PREFIX</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_external-working_directory"></a>working_directory</td><td align="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake_tool"></a></p>
|
||||||
|
<h2 id="cmake_tool"><a class="header" href="#cmake_tool">cmake_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake_tool(<a href="index.html#cmake_tool-name">name</a>, <a href="index.html#cmake_tool-cmake_srcs">cmake_srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building CMake. Invokes bootstrap script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-cmake_srcs"></a>cmake_srcs</td><td align="left">-</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#configure_make"></a></p>
|
||||||
|
<h2 id="configure_make"><a class="header" href="#configure_make">configure_make</a></h2>
|
||||||
|
<pre>
|
||||||
|
configure_make(<a href="index.html#configure_make-name">name</a>, <a href="index.html#configure_make-additional_inputs">additional_inputs</a>, <a href="index.html#configure_make-additional_tools">additional_tools</a>, <a href="index.html#configure_make-alwayslink">alwayslink</a>, <a href="index.html#configure_make-autoconf">autoconf</a>, <a href="index.html#configure_make-autoconf_env_vars">autoconf_env_vars</a>,
|
||||||
|
<a href="index.html#configure_make-autoconf_options">autoconf_options</a>, <a href="index.html#configure_make-autogen">autogen</a>, <a href="index.html#configure_make-autogen_command">autogen_command</a>, <a href="index.html#configure_make-autogen_env_vars">autogen_env_vars</a>, <a href="index.html#configure_make-autogen_options">autogen_options</a>,
|
||||||
|
<a href="index.html#configure_make-autoreconf">autoreconf</a>, <a href="index.html#configure_make-autoreconf_env_vars">autoreconf_env_vars</a>, <a href="index.html#configure_make-autoreconf_options">autoreconf_options</a>, <a href="index.html#configure_make-binaries">binaries</a>, <a href="index.html#configure_make-configure_command">configure_command</a>,
|
||||||
|
<a href="index.html#configure_make-configure_env_vars">configure_env_vars</a>, <a href="index.html#configure_make-configure_in_place">configure_in_place</a>, <a href="index.html#configure_make-configure_options">configure_options</a>, <a href="index.html#configure_make-data">data</a>, <a href="index.html#configure_make-defines">defines</a>, <a href="index.html#configure_make-deps">deps</a>, <a href="index.html#configure_make-env">env</a>,
|
||||||
|
<a href="index.html#configure_make-headers_only">headers_only</a>, <a href="index.html#configure_make-install_prefix">install_prefix</a>, <a href="index.html#configure_make-interface_libraries">interface_libraries</a>, <a href="index.html#configure_make-lib_name">lib_name</a>, <a href="index.html#configure_make-lib_source">lib_source</a>, <a href="index.html#configure_make-linkopts">linkopts</a>,
|
||||||
|
<a href="index.html#configure_make-make_commands">make_commands</a>, <a href="index.html#configure_make-out_bin_dir">out_bin_dir</a>, <a href="index.html#configure_make-out_include_dir">out_include_dir</a>, <a href="index.html#configure_make-out_lib_dir">out_lib_dir</a>, <a href="index.html#configure_make-postfix_script">postfix_script</a>,
|
||||||
|
<a href="index.html#configure_make-shared_libraries">shared_libraries</a>, <a href="index.html#configure_make-static_libraries">static_libraries</a>, <a href="index.html#configure_make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="configure_make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf"></a>autoconf</td><td align="left">Set to True if 'autoconf' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_env_vars"></a>autoconf_env_vars</td><td align="left">Environment variables to be set for 'autoconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_options"></a>autoconf_options</td><td align="left">Any options to be put in the 'autoconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen"></a>autogen</td><td align="left">Set to True if 'autogen.sh' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_command"></a>autogen_command</td><td align="left">The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.</td><td align="left">String</td><td align="left">optional</td><td align="left">"autogen.sh"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_env_vars"></a>autogen_env_vars</td><td align="left">Environment variables to be set for 'autogen' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_options"></a>autogen_options</td><td align="left">Any options to be put in the 'autogen.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf"></a>autoreconf</td><td align="left">Set to True if 'autoreconf' should be invoked before 'configure.', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_env_vars"></a>autoreconf_env_vars</td><td align="left">Environment variables to be set for 'autoreconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_options"></a>autoreconf_options</td><td align="left">Any options to be put in the 'autoreconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_command"></a>configure_command</td><td align="left">The name of the configuration script file, default: configure. The file must be in the root of the source directory.</td><td align="left">String</td><td align="left">optional</td><td align="left">"configure"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_env_vars"></a>configure_env_vars</td><td align="left">Environment variables to be set for the 'configure' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_in_place"></a>configure_in_place</td><td align="left">Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_options"></a>configure_options</td><td align="left">Any options to be put on the 'configure' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make"></a></p>
|
||||||
|
<h2 id="make"><a class="header" href="#make">make</a></h2>
|
||||||
|
<pre>
|
||||||
|
make(<a href="index.html#make-name">name</a>, <a href="index.html#make-additional_inputs">additional_inputs</a>, <a href="index.html#make-additional_tools">additional_tools</a>, <a href="index.html#make-alwayslink">alwayslink</a>, <a href="index.html#make-binaries">binaries</a>, <a href="index.html#make-data">data</a>, <a href="index.html#make-defines">defines</a>, <a href="index.html#make-deps">deps</a>, <a href="index.html#make-env">env</a>,
|
||||||
|
<a href="index.html#make-headers_only">headers_only</a>, <a href="index.html#make-interface_libraries">interface_libraries</a>, <a href="index.html#make-keep_going">keep_going</a>, <a href="index.html#make-lib_name">lib_name</a>, <a href="index.html#make-lib_source">lib_source</a>, <a href="index.html#make-linkopts">linkopts</a>, <a href="index.html#make-make_commands">make_commands</a>,
|
||||||
|
<a href="index.html#make-make_env_vars">make_env_vars</a>, <a href="index.html#make-out_bin_dir">out_bin_dir</a>, <a href="index.html#make-out_include_dir">out_include_dir</a>, <a href="index.html#make-out_lib_dir">out_lib_dir</a>, <a href="index.html#make-postfix_script">postfix_script</a>, <a href="index.html#make-prefix">prefix</a>,
|
||||||
|
<a href="index.html#make-shared_libraries">shared_libraries</a>, <a href="index.html#make-static_libraries">static_libraries</a>, <a href="index.html#make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with prefix="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-keep_going"></a>keep_going</td><td align="left">Keep going when some targets can not be made, -k flag is passed to make (applies only if make_commands attribute is not set). Please have a look at _create_make_script for default make_commands.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_commands"></a>make_commands</td><td align="left">Overriding make_commands default value to be empty, then we can provide better default value programmatically</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_env_vars"></a>make_env_vars</td><td align="left">Environment variables to be set for the 'configure' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-prefix"></a>prefix</td><td align="left">Install prefix, an absolute path. Passed to the GNU make via "make install PREFIX=<value>". By default, the install directory created under sandboxed execution root is used. Build results are copied to the Bazel's output directory, so the prefix is only important if it is recorded into any text files by Makefile script. In that case, it is important to note that rules_foreign_cc is overriding the paths under execution root with "BAZEL_GEN_ROOT" value.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make_tool"></a></p>
|
||||||
|
<h2 id="make_tool"><a class="header" href="#make_tool">make_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
make_tool(<a href="index.html#make_tool-name">name</a>, <a href="index.html#make_tool-make_srcs">make_srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Make. Invokes configure script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make_tool-make_srcs"></a>make_srcs</td><td align="left">target with the Make sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#native_tool_toolchain"></a></p>
|
||||||
|
<h2 id="native_tool_toolchain"><a class="header" href="#native_tool_toolchain">native_tool_toolchain</a></h2>
|
||||||
|
<pre>
|
||||||
|
native_tool_toolchain(<a href="index.html#native_tool_toolchain-name">name</a>, <a href="index.html#native_tool_toolchain-path">path</a>, <a href="index.html#native_tool_toolchain-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types <code>@rules_foreign_cc//tools/build_defs:cmake_toolchain</code> and <code>@rules_foreign_cc//tools/build_defs:ninja_toolchain</code>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">optional</td><td align="left">None</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja"></a></p>
|
||||||
|
<h2 id="ninja"><a class="header" href="#ninja">ninja</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja(<a href="index.html#ninja-name">name</a>, <a href="index.html#ninja-additional_inputs">additional_inputs</a>, <a href="index.html#ninja-additional_tools">additional_tools</a>, <a href="index.html#ninja-alwayslink">alwayslink</a>, <a href="index.html#ninja-args">args</a>, <a href="index.html#ninja-binaries">binaries</a>, <a href="index.html#ninja-data">data</a>, <a href="index.html#ninja-defines">defines</a>, <a href="index.html#ninja-deps">deps</a>,
|
||||||
|
<a href="index.html#ninja-directory">directory</a>, <a href="index.html#ninja-env">env</a>, <a href="index.html#ninja-headers_only">headers_only</a>, <a href="index.html#ninja-interface_libraries">interface_libraries</a>, <a href="index.html#ninja-lib_name">lib_name</a>, <a href="index.html#ninja-lib_source">lib_source</a>, <a href="index.html#ninja-linkopts">linkopts</a>, <a href="index.html#ninja-out_bin_dir">out_bin_dir</a>,
|
||||||
|
<a href="index.html#ninja-out_include_dir">out_include_dir</a>, <a href="index.html#ninja-out_lib_dir">out_lib_dir</a>, <a href="index.html#ninja-postfix_script">postfix_script</a>, <a href="index.html#ninja-shared_libraries">shared_libraries</a>, <a href="index.html#ninja-static_libraries">static_libraries</a>, <a href="index.html#ninja-targets">targets</a>,
|
||||||
|
<a href="index.html#ninja-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with <a href="https://ninja-build.org/">Ninja</a>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>ninja</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-binaries"></a>binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-directory"></a>directory</td><td align="left">A directory to pass as the <code>-C</code> argument. The rule will always use the root directory of the <code>lib_sources</code> attribute if this attribute is not set</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-headers_only"></a>headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-interface_libraries"></a>interface_libraries</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-shared_libraries"></a>shared_libraries</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-static_libraries"></a>static_libraries</td><td align="left">Optional names of the resulting static libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-targets"></a>targets</td><td align="left">A list of ninja targets to build. To call the default target, simply pass <code>""</code> as one of the items to this attribute.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja_tool"></a></p>
|
||||||
|
<h2 id="ninja_tool"><a class="header" href="#ninja_tool">ninja_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja_tool(<a href="index.html#ninja_tool-name">name</a>, <a href="index.html#ninja_tool-ninja_srcs">ninja_srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Ninja. Invokes configure script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-ninja_srcs"></a>ninja_srcs</td><td align="left">-</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ConfigureParameters"></a></p>
|
||||||
|
<h2 id="configureparameters"><a class="header" href="#configureparameters">ConfigureParameters</a></h2>
|
||||||
|
<pre>
|
||||||
|
ConfigureParameters(<a href="index.html#ConfigureParameters-ctx">ctx</a>, <a href="index.html#ConfigureParameters-attrs">attrs</a>, <a href="index.html#ConfigureParameters-inputs">inputs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Parameters of create_configure_script callback function, called by
|
||||||
|
cc_external_rule_impl function. create_configure_script creates the configuration part
|
||||||
|
of the script, and allows to reuse the inputs structure, created by the framework.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ConfigureParameters-ctx"></a>ctx</td><td align="left">Rule context</td></tr>
|
||||||
|
<tr><td align="left"><a id="ConfigureParameters-attrs"></a>attrs</td><td align="left">Attributes struct, created by create_attrs function above</td></tr>
|
||||||
|
<tr><td align="left"><a id="ConfigureParameters-inputs"></a>inputs</td><td align="left">InputFiles provider: summarized information on rule inputs, created by framework function, to be reused in script creator. Contains in particular merged compilation and linking dependencies.</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcArtifact"></a></p>
|
||||||
|
<h2 id="foreignccartifact"><a class="header" href="#foreignccartifact">ForeignCcArtifact</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcArtifact(<a href="index.html#ForeignCcArtifact-bin_dir_name">bin_dir_name</a>, <a href="index.html#ForeignCcArtifact-gen_dir">gen_dir</a>, <a href="index.html#ForeignCcArtifact-include_dir_name">include_dir_name</a>, <a href="index.html#ForeignCcArtifact-lib_dir_name">lib_dir_name</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Groups information about the external library install directory,
|
||||||
|
and relative bin, include and lib directories.</p>
|
||||||
|
<p>Serves to pass transitive information about externally built artifacts up the dependency chain.</p>
|
||||||
|
<p>Can not be used as a top-level provider.
|
||||||
|
Instances of ForeignCcArtifact are incapsulated in a depset ForeignCcDeps#artifacts.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-bin_dir_name"></a>bin_dir_name</td><td align="left">Bin directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-gen_dir"></a>gen_dir</td><td align="left">Install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-include_dir_name"></a>include_dir_name</td><td align="left">Include directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-lib_dir_name"></a>lib_dir_name</td><td align="left">Lib directory, relative to install directory</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcDeps"></a></p>
|
||||||
|
<h2 id="foreignccdeps"><a class="header" href="#foreignccdeps">ForeignCcDeps</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcDeps(<a href="index.html#ForeignCcDeps-artifacts">artifacts</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Provider to pass transitive information about external libraries.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcDeps-artifacts"></a>artifacts</td><td align="left">Depset of ForeignCcArtifact</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#InputFiles"></a></p>
|
||||||
|
<h2 id="inputfiles"><a class="header" href="#inputfiles">InputFiles</a></h2>
|
||||||
|
<pre>
|
||||||
|
InputFiles(<a href="index.html#InputFiles-headers">headers</a>, <a href="index.html#InputFiles-include_dirs">include_dirs</a>, <a href="index.html#InputFiles-libs">libs</a>, <a href="index.html#InputFiles-tools_files">tools_files</a>, <a href="index.html#InputFiles-ext_build_dirs">ext_build_dirs</a>, <a href="index.html#InputFiles-deps_compilation_info">deps_compilation_info</a>,
|
||||||
|
<a href="index.html#InputFiles-deps_linking_info">deps_linking_info</a>, <a href="index.html#InputFiles-declared_inputs">declared_inputs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Provider to keep different kinds of input files, directories, and C/C++ compilation and linking info from dependencies</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="InputFiles-headers"></a>headers</td><td align="left">Include files built by Bazel. Will be copied into $EXT_BUILD_DEPS/include.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-include_dirs"></a>include_dirs</td><td align="left">Include directories built by Bazel. Will be copied into $EXT_BUILD_DEPS/include.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-libs"></a>libs</td><td align="left">Library files built by Bazel. Will be copied into $EXT_BUILD_DEPS/lib.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-tools_files"></a>tools_files</td><td align="left">Files and directories with tools needed for configuration/building to be copied into the bin folder, which is added to the PATH</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-ext_build_dirs"></a>ext_build_dirs</td><td align="left">Directories with libraries, built by framework function. This directories should be copied into $EXT_BUILD_DEPS/lib-name as is, with all contents.</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-deps_compilation_info"></a>deps_compilation_info</td><td align="left">Merged CcCompilationInfo from deps attribute</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-deps_linking_info"></a>deps_linking_info</td><td align="left">Merged CcLinkingInfo from deps attribute</td></tr>
|
||||||
|
<tr><td align="left"><a id="InputFiles-declared_inputs"></a>declared_inputs</td><td align="left">All files and directories that must be declared as action inputs</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ToolInfo"></a></p>
|
||||||
|
<h2 id="toolinfo"><a class="header" href="#toolinfo">ToolInfo</a></h2>
|
||||||
|
<pre>
|
||||||
|
ToolInfo(<a href="index.html#ToolInfo-path">path</a>, <a href="index.html#ToolInfo-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Information about the native tool</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td></tr>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#WrappedOutputs"></a></p>
|
||||||
|
<h2 id="wrappedoutputs"><a class="header" href="#wrappedoutputs">WrappedOutputs</a></h2>
|
||||||
|
<pre>
|
||||||
|
WrappedOutputs(<a href="index.html#WrappedOutputs-log_file">log_file</a>, <a href="index.html#WrappedOutputs-script_file">script_file</a>, <a href="index.html#WrappedOutputs-wrapper_script">wrapper_script</a>, <a href="index.html#WrappedOutputs-wrapper_script_file">wrapper_script_file</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Structure for passing the log and scripts file information, and wrapper script text.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-log_file"></a>log_file</td><td align="left">Execution log file</td></tr>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-script_file"></a>script_file</td><td align="left">Main script file</td></tr>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-wrapper_script"></a>wrapper_script</td><td align="left">Wrapper script text to execute</td></tr>
|
||||||
|
<tr><td align="left"><a id="WrappedOutputs-wrapper_script_file"></a>wrapper_script_file</td><td align="left">Wrapper script file (output for debugging purposes)</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#rules_foreign_cc_dependencies"></a></p>
|
||||||
|
<h2 id="rules_foreign_cc_dependencies"><a class="header" href="#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></h2>
|
||||||
|
<pre>
|
||||||
|
rules_foreign_cc_dependencies(<a href="index.html#rules_foreign_cc_dependencies-native_tools_toolchains">native_tools_toolchains</a>, <a href="index.html#rules_foreign_cc_dependencies-register_default_tools">register_default_tools</a>, <a href="index.html#rules_foreign_cc_dependencies-cmake_version">cmake_version</a>,
|
||||||
|
<a href="index.html#rules_foreign_cc_dependencies-ninja_version">ninja_version</a>, <a href="index.html#rules_foreign_cc_dependencies-register_preinstalled_tools">register_preinstalled_tools</a>,
|
||||||
|
<a href="index.html#rules_foreign_cc_dependencies-additional_shell_toolchain_mappings">additional_shell_toolchain_mappings</a>, <a href="index.html#rules_foreign_cc_dependencies-additional_shell_toolchain_package">additional_shell_toolchain_package</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Call this function from the WORKSPACE file to initialize rules_foreign_cc dependencies and let neccesary code generation happen (Code generation is needed to support different variants of the C++ Starlark API.).</p>
|
||||||
|
<p><strong>PARAMETERS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-native_tools_toolchains"></a>native_tools_toolchains</td><td align="left">pass the toolchains for toolchain types '@rules_foreign_cc//tools/build_defs:cmake_toolchain' and '@rules_foreign_cc//tools/build_defs:ninja_toolchain' with the needed platform constraints. If you do not pass anything, registered default toolchains will be selected (see below).</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_default_tools"></a>register_default_tools</td><td align="left">If True, the cmake and ninja toolchains, calling corresponding preinstalled binaries by name (cmake, ninja) will be registered after 'native_tools_toolchains' without any platform constraints. The default is True.</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-cmake_version"></a>cmake_version</td><td align="left">The target version of the default cmake toolchain if <code>register_default_tools</code> is set to <code>True</code>.</td><td align="left"><code>"3.19.6"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-ninja_version"></a>ninja_version</td><td align="left">The target version of the default ninja toolchain if <code>register_default_tools</code> is set to <code>True</code>.</td><td align="left"><code>"1.10.2"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_preinstalled_tools"></a>register_preinstalled_tools</td><td align="left">If true, toolchains will be registered for the native built tools installed on the exec host</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_mappings"></a>additional_shell_toolchain_mappings</td><td align="left">Mappings of the shell toolchain functions to execution and target platforms constraints. Similar to what defined in @rules_foreign_cc//tools/build_defs/shell_toolchain/toolchains:toolchain_mappings.bzl in the TOOLCHAIN_MAPPINGS list. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_package"></a>additional_shell_toolchain_package</td><td align="left">A package under which additional toolchains, referencing the generated data for the passed additonal_shell_toolchain_mappings, will be defined. This value is needed since register_toolchains() is called for these toolchains. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>None</code></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
|
||||||
|
|
||||||
|
<div style="clear: both"></div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.addEventListener('load', function() {
|
||||||
|
window.setTimeout(window.print, 100);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
483
0.1.0/searcher.js
Normal file
483
0.1.0/searcher.js
Normal file
|
|
@ -0,0 +1,483 @@
|
||||||
|
"use strict";
|
||||||
|
window.search = window.search || {};
|
||||||
|
(function search(search) {
|
||||||
|
// Search functionality
|
||||||
|
//
|
||||||
|
// You can use !hasFocus() to prevent keyhandling in your key
|
||||||
|
// event handlers while the user is typing their search.
|
||||||
|
|
||||||
|
if (!Mark || !elasticlunr) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
//IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
|
||||||
|
if (!String.prototype.startsWith) {
|
||||||
|
String.prototype.startsWith = function(search, pos) {
|
||||||
|
return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
var search_wrap = document.getElementById('search-wrapper'),
|
||||||
|
searchbar = document.getElementById('searchbar'),
|
||||||
|
searchbar_outer = document.getElementById('searchbar-outer'),
|
||||||
|
searchresults = document.getElementById('searchresults'),
|
||||||
|
searchresults_outer = document.getElementById('searchresults-outer'),
|
||||||
|
searchresults_header = document.getElementById('searchresults-header'),
|
||||||
|
searchicon = document.getElementById('search-toggle'),
|
||||||
|
content = document.getElementById('content'),
|
||||||
|
|
||||||
|
searchindex = null,
|
||||||
|
doc_urls = [],
|
||||||
|
results_options = {
|
||||||
|
teaser_word_count: 30,
|
||||||
|
limit_results: 30,
|
||||||
|
},
|
||||||
|
search_options = {
|
||||||
|
bool: "AND",
|
||||||
|
expand: true,
|
||||||
|
fields: {
|
||||||
|
title: {boost: 1},
|
||||||
|
body: {boost: 1},
|
||||||
|
breadcrumbs: {boost: 0}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
mark_exclude = [],
|
||||||
|
marker = new Mark(content),
|
||||||
|
current_searchterm = "",
|
||||||
|
URL_SEARCH_PARAM = 'search',
|
||||||
|
URL_MARK_PARAM = 'highlight',
|
||||||
|
teaser_count = 0,
|
||||||
|
|
||||||
|
SEARCH_HOTKEY_KEYCODE = 83,
|
||||||
|
ESCAPE_KEYCODE = 27,
|
||||||
|
DOWN_KEYCODE = 40,
|
||||||
|
UP_KEYCODE = 38,
|
||||||
|
SELECT_KEYCODE = 13;
|
||||||
|
|
||||||
|
function hasFocus() {
|
||||||
|
return searchbar === document.activeElement;
|
||||||
|
}
|
||||||
|
|
||||||
|
function removeChildren(elem) {
|
||||||
|
while (elem.firstChild) {
|
||||||
|
elem.removeChild(elem.firstChild);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper to parse a url into its building blocks.
|
||||||
|
function parseURL(url) {
|
||||||
|
var a = document.createElement('a');
|
||||||
|
a.href = url;
|
||||||
|
return {
|
||||||
|
source: url,
|
||||||
|
protocol: a.protocol.replace(':',''),
|
||||||
|
host: a.hostname,
|
||||||
|
port: a.port,
|
||||||
|
params: (function(){
|
||||||
|
var ret = {};
|
||||||
|
var seg = a.search.replace(/^\?/,'').split('&');
|
||||||
|
var len = seg.length, i = 0, s;
|
||||||
|
for (;i<len;i++) {
|
||||||
|
if (!seg[i]) { continue; }
|
||||||
|
s = seg[i].split('=');
|
||||||
|
ret[s[0]] = s[1];
|
||||||
|
}
|
||||||
|
return ret;
|
||||||
|
})(),
|
||||||
|
file: (a.pathname.match(/\/([^/?#]+)$/i) || [,''])[1],
|
||||||
|
hash: a.hash.replace('#',''),
|
||||||
|
path: a.pathname.replace(/^([^/])/,'/$1')
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper to recreate a url string from its building blocks.
|
||||||
|
function renderURL(urlobject) {
|
||||||
|
var url = urlobject.protocol + "://" + urlobject.host;
|
||||||
|
if (urlobject.port != "") {
|
||||||
|
url += ":" + urlobject.port;
|
||||||
|
}
|
||||||
|
url += urlobject.path;
|
||||||
|
var joiner = "?";
|
||||||
|
for(var prop in urlobject.params) {
|
||||||
|
if(urlobject.params.hasOwnProperty(prop)) {
|
||||||
|
url += joiner + prop + "=" + urlobject.params[prop];
|
||||||
|
joiner = "&";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (urlobject.hash != "") {
|
||||||
|
url += "#" + urlobject.hash;
|
||||||
|
}
|
||||||
|
return url;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper to escape html special chars for displaying the teasers
|
||||||
|
var escapeHTML = (function() {
|
||||||
|
var MAP = {
|
||||||
|
'&': '&',
|
||||||
|
'<': '<',
|
||||||
|
'>': '>',
|
||||||
|
'"': '"',
|
||||||
|
"'": '''
|
||||||
|
};
|
||||||
|
var repl = function(c) { return MAP[c]; };
|
||||||
|
return function(s) {
|
||||||
|
return s.replace(/[&<>'"]/g, repl);
|
||||||
|
};
|
||||||
|
})();
|
||||||
|
|
||||||
|
function formatSearchMetric(count, searchterm) {
|
||||||
|
if (count == 1) {
|
||||||
|
return count + " search result for '" + searchterm + "':";
|
||||||
|
} else if (count == 0) {
|
||||||
|
return "No search results for '" + searchterm + "'.";
|
||||||
|
} else {
|
||||||
|
return count + " search results for '" + searchterm + "':";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatSearchResult(result, searchterms) {
|
||||||
|
var teaser = makeTeaser(escapeHTML(result.doc.body), searchterms);
|
||||||
|
teaser_count++;
|
||||||
|
|
||||||
|
// The ?URL_MARK_PARAM= parameter belongs inbetween the page and the #heading-anchor
|
||||||
|
var url = doc_urls[result.ref].split("#");
|
||||||
|
if (url.length == 1) { // no anchor found
|
||||||
|
url.push("");
|
||||||
|
}
|
||||||
|
|
||||||
|
// encodeURIComponent escapes all chars that could allow an XSS except
|
||||||
|
// for '. Due to that we also manually replace ' with its url-encoded
|
||||||
|
// representation (%27).
|
||||||
|
var searchterms = encodeURIComponent(searchterms.join(" ")).replace(/\'/g, "%27");
|
||||||
|
|
||||||
|
return '<a href="' + path_to_root + url[0] + '?' + URL_MARK_PARAM + '=' + searchterms + '#' + url[1]
|
||||||
|
+ '" aria-details="teaser_' + teaser_count + '">' + result.doc.breadcrumbs + '</a>'
|
||||||
|
+ '<span class="teaser" id="teaser_' + teaser_count + '" aria-label="Search Result Teaser">'
|
||||||
|
+ teaser + '</span>';
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeTeaser(body, searchterms) {
|
||||||
|
// The strategy is as follows:
|
||||||
|
// First, assign a value to each word in the document:
|
||||||
|
// Words that correspond to search terms (stemmer aware): 40
|
||||||
|
// Normal words: 2
|
||||||
|
// First word in a sentence: 8
|
||||||
|
// Then use a sliding window with a constant number of words and count the
|
||||||
|
// sum of the values of the words within the window. Then use the window that got the
|
||||||
|
// maximum sum. If there are multiple maximas, then get the last one.
|
||||||
|
// Enclose the terms in <em>.
|
||||||
|
var stemmed_searchterms = searchterms.map(function(w) {
|
||||||
|
return elasticlunr.stemmer(w.toLowerCase());
|
||||||
|
});
|
||||||
|
var searchterm_weight = 40;
|
||||||
|
var weighted = []; // contains elements of ["word", weight, index_in_document]
|
||||||
|
// split in sentences, then words
|
||||||
|
var sentences = body.toLowerCase().split('. ');
|
||||||
|
var index = 0;
|
||||||
|
var value = 0;
|
||||||
|
var searchterm_found = false;
|
||||||
|
for (var sentenceindex in sentences) {
|
||||||
|
var words = sentences[sentenceindex].split(' ');
|
||||||
|
value = 8;
|
||||||
|
for (var wordindex in words) {
|
||||||
|
var word = words[wordindex];
|
||||||
|
if (word.length > 0) {
|
||||||
|
for (var searchtermindex in stemmed_searchterms) {
|
||||||
|
if (elasticlunr.stemmer(word).startsWith(stemmed_searchterms[searchtermindex])) {
|
||||||
|
value = searchterm_weight;
|
||||||
|
searchterm_found = true;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
weighted.push([word, value, index]);
|
||||||
|
value = 2;
|
||||||
|
}
|
||||||
|
index += word.length;
|
||||||
|
index += 1; // ' ' or '.' if last word in sentence
|
||||||
|
};
|
||||||
|
index += 1; // because we split at a two-char boundary '. '
|
||||||
|
};
|
||||||
|
|
||||||
|
if (weighted.length == 0) {
|
||||||
|
return body;
|
||||||
|
}
|
||||||
|
|
||||||
|
var window_weight = [];
|
||||||
|
var window_size = Math.min(weighted.length, results_options.teaser_word_count);
|
||||||
|
|
||||||
|
var cur_sum = 0;
|
||||||
|
for (var wordindex = 0; wordindex < window_size; wordindex++) {
|
||||||
|
cur_sum += weighted[wordindex][1];
|
||||||
|
};
|
||||||
|
window_weight.push(cur_sum);
|
||||||
|
for (var wordindex = 0; wordindex < weighted.length - window_size; wordindex++) {
|
||||||
|
cur_sum -= weighted[wordindex][1];
|
||||||
|
cur_sum += weighted[wordindex + window_size][1];
|
||||||
|
window_weight.push(cur_sum);
|
||||||
|
};
|
||||||
|
|
||||||
|
if (searchterm_found) {
|
||||||
|
var max_sum = 0;
|
||||||
|
var max_sum_window_index = 0;
|
||||||
|
// backwards
|
||||||
|
for (var i = window_weight.length - 1; i >= 0; i--) {
|
||||||
|
if (window_weight[i] > max_sum) {
|
||||||
|
max_sum = window_weight[i];
|
||||||
|
max_sum_window_index = i;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
} else {
|
||||||
|
max_sum_window_index = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// add <em/> around searchterms
|
||||||
|
var teaser_split = [];
|
||||||
|
var index = weighted[max_sum_window_index][2];
|
||||||
|
for (var i = max_sum_window_index; i < max_sum_window_index+window_size; i++) {
|
||||||
|
var word = weighted[i];
|
||||||
|
if (index < word[2]) {
|
||||||
|
// missing text from index to start of `word`
|
||||||
|
teaser_split.push(body.substring(index, word[2]));
|
||||||
|
index = word[2];
|
||||||
|
}
|
||||||
|
if (word[1] == searchterm_weight) {
|
||||||
|
teaser_split.push("<em>")
|
||||||
|
}
|
||||||
|
index = word[2] + word[0].length;
|
||||||
|
teaser_split.push(body.substring(word[2], index));
|
||||||
|
if (word[1] == searchterm_weight) {
|
||||||
|
teaser_split.push("</em>")
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return teaser_split.join('');
|
||||||
|
}
|
||||||
|
|
||||||
|
function init(config) {
|
||||||
|
results_options = config.results_options;
|
||||||
|
search_options = config.search_options;
|
||||||
|
searchbar_outer = config.searchbar_outer;
|
||||||
|
doc_urls = config.doc_urls;
|
||||||
|
searchindex = elasticlunr.Index.load(config.index);
|
||||||
|
|
||||||
|
// Set up events
|
||||||
|
searchicon.addEventListener('click', function(e) { searchIconClickHandler(); }, false);
|
||||||
|
searchbar.addEventListener('keyup', function(e) { searchbarKeyUpHandler(); }, false);
|
||||||
|
document.addEventListener('keydown', function(e) { globalKeyHandler(e); }, false);
|
||||||
|
// If the user uses the browser buttons, do the same as if a reload happened
|
||||||
|
window.onpopstate = function(e) { doSearchOrMarkFromUrl(); };
|
||||||
|
// Suppress "submit" events so the page doesn't reload when the user presses Enter
|
||||||
|
document.addEventListener('submit', function(e) { e.preventDefault(); }, false);
|
||||||
|
|
||||||
|
// If reloaded, do the search or mark again, depending on the current url parameters
|
||||||
|
doSearchOrMarkFromUrl();
|
||||||
|
}
|
||||||
|
|
||||||
|
function unfocusSearchbar() {
|
||||||
|
// hacky, but just focusing a div only works once
|
||||||
|
var tmp = document.createElement('input');
|
||||||
|
tmp.setAttribute('style', 'position: absolute; opacity: 0;');
|
||||||
|
searchicon.appendChild(tmp);
|
||||||
|
tmp.focus();
|
||||||
|
tmp.remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
// On reload or browser history backwards/forwards events, parse the url and do search or mark
|
||||||
|
function doSearchOrMarkFromUrl() {
|
||||||
|
// Check current URL for search request
|
||||||
|
var url = parseURL(window.location.href);
|
||||||
|
if (url.params.hasOwnProperty(URL_SEARCH_PARAM)
|
||||||
|
&& url.params[URL_SEARCH_PARAM] != "") {
|
||||||
|
showSearch(true);
|
||||||
|
searchbar.value = decodeURIComponent(
|
||||||
|
(url.params[URL_SEARCH_PARAM]+'').replace(/\+/g, '%20'));
|
||||||
|
searchbarKeyUpHandler(); // -> doSearch()
|
||||||
|
} else {
|
||||||
|
showSearch(false);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url.params.hasOwnProperty(URL_MARK_PARAM)) {
|
||||||
|
var words = decodeURIComponent(url.params[URL_MARK_PARAM]).split(' ');
|
||||||
|
marker.mark(words, {
|
||||||
|
exclude: mark_exclude
|
||||||
|
});
|
||||||
|
|
||||||
|
var markers = document.querySelectorAll("mark");
|
||||||
|
function hide() {
|
||||||
|
for (var i = 0; i < markers.length; i++) {
|
||||||
|
markers[i].classList.add("fade-out");
|
||||||
|
window.setTimeout(function(e) { marker.unmark(); }, 300);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (var i = 0; i < markers.length; i++) {
|
||||||
|
markers[i].addEventListener('click', hide);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Eventhandler for keyevents on `document`
|
||||||
|
function globalKeyHandler(e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey || e.target.type === 'textarea' || e.target.type === 'text') { return; }
|
||||||
|
|
||||||
|
if (e.keyCode === ESCAPE_KEYCODE) {
|
||||||
|
e.preventDefault();
|
||||||
|
searchbar.classList.remove("active");
|
||||||
|
setSearchUrlParameters("",
|
||||||
|
(searchbar.value.trim() !== "") ? "push" : "replace");
|
||||||
|
if (hasFocus()) {
|
||||||
|
unfocusSearchbar();
|
||||||
|
}
|
||||||
|
showSearch(false);
|
||||||
|
marker.unmark();
|
||||||
|
} else if (!hasFocus() && e.keyCode === SEARCH_HOTKEY_KEYCODE) {
|
||||||
|
e.preventDefault();
|
||||||
|
showSearch(true);
|
||||||
|
window.scrollTo(0, 0);
|
||||||
|
searchbar.select();
|
||||||
|
} else if (hasFocus() && e.keyCode === DOWN_KEYCODE) {
|
||||||
|
e.preventDefault();
|
||||||
|
unfocusSearchbar();
|
||||||
|
searchresults.firstElementChild.classList.add("focus");
|
||||||
|
} else if (!hasFocus() && (e.keyCode === DOWN_KEYCODE
|
||||||
|
|| e.keyCode === UP_KEYCODE
|
||||||
|
|| e.keyCode === SELECT_KEYCODE)) {
|
||||||
|
// not `:focus` because browser does annoying scrolling
|
||||||
|
var focused = searchresults.querySelector("li.focus");
|
||||||
|
if (!focused) return;
|
||||||
|
e.preventDefault();
|
||||||
|
if (e.keyCode === DOWN_KEYCODE) {
|
||||||
|
var next = focused.nextElementSibling;
|
||||||
|
if (next) {
|
||||||
|
focused.classList.remove("focus");
|
||||||
|
next.classList.add("focus");
|
||||||
|
}
|
||||||
|
} else if (e.keyCode === UP_KEYCODE) {
|
||||||
|
focused.classList.remove("focus");
|
||||||
|
var prev = focused.previousElementSibling;
|
||||||
|
if (prev) {
|
||||||
|
prev.classList.add("focus");
|
||||||
|
} else {
|
||||||
|
searchbar.select();
|
||||||
|
}
|
||||||
|
} else { // SELECT_KEYCODE
|
||||||
|
window.location.assign(focused.querySelector('a'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function showSearch(yes) {
|
||||||
|
if (yes) {
|
||||||
|
search_wrap.classList.remove('hidden');
|
||||||
|
searchicon.setAttribute('aria-expanded', 'true');
|
||||||
|
} else {
|
||||||
|
search_wrap.classList.add('hidden');
|
||||||
|
searchicon.setAttribute('aria-expanded', 'false');
|
||||||
|
var results = searchresults.children;
|
||||||
|
for (var i = 0; i < results.length; i++) {
|
||||||
|
results[i].classList.remove("focus");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function showResults(yes) {
|
||||||
|
if (yes) {
|
||||||
|
searchresults_outer.classList.remove('hidden');
|
||||||
|
} else {
|
||||||
|
searchresults_outer.classList.add('hidden');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Eventhandler for search icon
|
||||||
|
function searchIconClickHandler() {
|
||||||
|
if (search_wrap.classList.contains('hidden')) {
|
||||||
|
showSearch(true);
|
||||||
|
window.scrollTo(0, 0);
|
||||||
|
searchbar.select();
|
||||||
|
} else {
|
||||||
|
showSearch(false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Eventhandler for keyevents while the searchbar is focused
|
||||||
|
function searchbarKeyUpHandler() {
|
||||||
|
var searchterm = searchbar.value.trim();
|
||||||
|
if (searchterm != "") {
|
||||||
|
searchbar.classList.add("active");
|
||||||
|
doSearch(searchterm);
|
||||||
|
} else {
|
||||||
|
searchbar.classList.remove("active");
|
||||||
|
showResults(false);
|
||||||
|
removeChildren(searchresults);
|
||||||
|
}
|
||||||
|
|
||||||
|
setSearchUrlParameters(searchterm, "push_if_new_search_else_replace");
|
||||||
|
|
||||||
|
// Remove marks
|
||||||
|
marker.unmark();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update current url with ?URL_SEARCH_PARAM= parameter, remove ?URL_MARK_PARAM and #heading-anchor .
|
||||||
|
// `action` can be one of "push", "replace", "push_if_new_search_else_replace"
|
||||||
|
// and replaces or pushes a new browser history item.
|
||||||
|
// "push_if_new_search_else_replace" pushes if there is no `?URL_SEARCH_PARAM=abc` yet.
|
||||||
|
function setSearchUrlParameters(searchterm, action) {
|
||||||
|
var url = parseURL(window.location.href);
|
||||||
|
var first_search = ! url.params.hasOwnProperty(URL_SEARCH_PARAM);
|
||||||
|
if (searchterm != "" || action == "push_if_new_search_else_replace") {
|
||||||
|
url.params[URL_SEARCH_PARAM] = searchterm;
|
||||||
|
delete url.params[URL_MARK_PARAM];
|
||||||
|
url.hash = "";
|
||||||
|
} else {
|
||||||
|
delete url.params[URL_MARK_PARAM];
|
||||||
|
delete url.params[URL_SEARCH_PARAM];
|
||||||
|
}
|
||||||
|
// A new search will also add a new history item, so the user can go back
|
||||||
|
// to the page prior to searching. A updated search term will only replace
|
||||||
|
// the url.
|
||||||
|
if (action == "push" || (action == "push_if_new_search_else_replace" && first_search) ) {
|
||||||
|
history.pushState({}, document.title, renderURL(url));
|
||||||
|
} else if (action == "replace" || (action == "push_if_new_search_else_replace" && !first_search) ) {
|
||||||
|
history.replaceState({}, document.title, renderURL(url));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function doSearch(searchterm) {
|
||||||
|
|
||||||
|
// Don't search the same twice
|
||||||
|
if (current_searchterm == searchterm) { return; }
|
||||||
|
else { current_searchterm = searchterm; }
|
||||||
|
|
||||||
|
if (searchindex == null) { return; }
|
||||||
|
|
||||||
|
// Do the actual search
|
||||||
|
var results = searchindex.search(searchterm, search_options);
|
||||||
|
var resultcount = Math.min(results.length, results_options.limit_results);
|
||||||
|
|
||||||
|
// Display search metrics
|
||||||
|
searchresults_header.innerText = formatSearchMetric(resultcount, searchterm);
|
||||||
|
|
||||||
|
// Clear and insert results
|
||||||
|
var searchterms = searchterm.split(' ');
|
||||||
|
removeChildren(searchresults);
|
||||||
|
for(var i = 0; i < resultcount ; i++){
|
||||||
|
var resultElem = document.createElement('li');
|
||||||
|
resultElem.innerHTML = formatSearchResult(results[i], searchterms);
|
||||||
|
searchresults.appendChild(resultElem);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display results
|
||||||
|
showResults(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
fetch(path_to_root + 'searchindex.json')
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(json => init(json))
|
||||||
|
.catch(error => { // Try to load searchindex.js if fetch failed
|
||||||
|
var script = document.createElement('script');
|
||||||
|
script.src = path_to_root + 'searchindex.js';
|
||||||
|
script.onload = () => init(window.search);
|
||||||
|
document.head.appendChild(script);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Exported functions
|
||||||
|
search.hasFocus = hasFocus;
|
||||||
|
})(window.search);
|
||||||
1
0.1.0/searchindex.js
Normal file
1
0.1.0/searchindex.js
Normal file
File diff suppressed because one or more lines are too long
1
0.1.0/searchindex.json
Normal file
1
0.1.0/searchindex.json
Normal file
File diff suppressed because one or more lines are too long
104
0.1.0/tomorrow-night.css
Normal file
104
0.1.0/tomorrow-night.css
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
/* Tomorrow Night Theme */
|
||||||
|
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
||||||
|
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
|
||||||
|
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
||||||
|
|
||||||
|
/* Tomorrow Comment */
|
||||||
|
.hljs-comment {
|
||||||
|
color: #969896;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Red */
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-tag,
|
||||||
|
.hljs-regexp,
|
||||||
|
.ruby .hljs-constant,
|
||||||
|
.xml .hljs-tag .hljs-title,
|
||||||
|
.xml .hljs-pi,
|
||||||
|
.xml .hljs-doctype,
|
||||||
|
.html .hljs-doctype,
|
||||||
|
.css .hljs-id,
|
||||||
|
.css .hljs-class,
|
||||||
|
.css .hljs-pseudo {
|
||||||
|
color: #cc6666;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Orange */
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-preprocessor,
|
||||||
|
.hljs-pragma,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-params,
|
||||||
|
.hljs-constant {
|
||||||
|
color: #de935f;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Yellow */
|
||||||
|
.ruby .hljs-class .hljs-title,
|
||||||
|
.css .hljs-rule .hljs-attribute {
|
||||||
|
color: #f0c674;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Green */
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-value,
|
||||||
|
.hljs-inheritance,
|
||||||
|
.hljs-header,
|
||||||
|
.hljs-name,
|
||||||
|
.ruby .hljs-symbol,
|
||||||
|
.xml .hljs-cdata {
|
||||||
|
color: #b5bd68;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Aqua */
|
||||||
|
.hljs-title,
|
||||||
|
.css .hljs-hexcolor {
|
||||||
|
color: #8abeb7;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Blue */
|
||||||
|
.hljs-function,
|
||||||
|
.python .hljs-decorator,
|
||||||
|
.python .hljs-title,
|
||||||
|
.ruby .hljs-function .hljs-title,
|
||||||
|
.ruby .hljs-title .hljs-keyword,
|
||||||
|
.perl .hljs-sub,
|
||||||
|
.javascript .hljs-title,
|
||||||
|
.coffeescript .hljs-title {
|
||||||
|
color: #81a2be;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Purple */
|
||||||
|
.hljs-keyword,
|
||||||
|
.javascript .hljs-function {
|
||||||
|
color: #b294bb;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
background: #1d1f21;
|
||||||
|
color: #c5c8c6;
|
||||||
|
padding: 0.5em;
|
||||||
|
-webkit-text-size-adjust: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.coffeescript .javascript,
|
||||||
|
.javascript .xml,
|
||||||
|
.tex .hljs-formula,
|
||||||
|
.xml .javascript,
|
||||||
|
.xml .vbscript,
|
||||||
|
.xml .css,
|
||||||
|
.xml .hljs-cdata {
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
color: #718c00;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
color: #c82829;
|
||||||
|
}
|
||||||
1
0.2.0/.nojekyll
Normal file
1
0.2.0/.nojekyll
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
This file makes sure that Github Pages doesn't process mdBook's output.
|
||||||
190
0.2.0/404.html
Normal file
190
0.2.0/404.html
Normal file
|
|
@ -0,0 +1,190 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title></title>
|
||||||
|
<base href="/">
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
|
||||||
|
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
|
||||||
|
|
||||||
|
<div style="clear: both"></div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
4
0.2.0/FontAwesome/css/font-awesome.css
vendored
Normal file
4
0.2.0/FontAwesome/css/font-awesome.css
vendored
Normal file
File diff suppressed because one or more lines are too long
BIN
0.2.0/FontAwesome/fonts/FontAwesome.ttf
Normal file
BIN
0.2.0/FontAwesome/fonts/FontAwesome.ttf
Normal file
Binary file not shown.
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.eot
Normal file
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.eot
Normal file
Binary file not shown.
2671
0.2.0/FontAwesome/fonts/fontawesome-webfont.svg
Normal file
2671
0.2.0/FontAwesome/fonts/fontawesome-webfont.svg
Normal file
File diff suppressed because it is too large
Load diff
|
After Width: | Height: | Size: 434 KiB |
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.ttf
Normal file
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.ttf
Normal file
Binary file not shown.
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.woff
Normal file
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.woff
Normal file
Binary file not shown.
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.woff2
Normal file
BIN
0.2.0/FontAwesome/fonts/fontawesome-webfont.woff2
Normal file
Binary file not shown.
79
0.2.0/ayu-highlight.css
Normal file
79
0.2.0/ayu-highlight.css
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
/*
|
||||||
|
Based off of the Ayu theme
|
||||||
|
Original by Dempfi (https://github.com/dempfi/ayu)
|
||||||
|
*/
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
background: #191f26;
|
||||||
|
color: #e6e1cf;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-quote {
|
||||||
|
color: #5c6773;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-attr,
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-link,
|
||||||
|
.hljs-selector-id,
|
||||||
|
.hljs-selector-class {
|
||||||
|
color: #ff7733;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-meta,
|
||||||
|
.hljs-builtin-name,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-type,
|
||||||
|
.hljs-params {
|
||||||
|
color: #ffee99;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-bullet {
|
||||||
|
color: #b8cc52;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-title,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-section {
|
||||||
|
color: #ffb454;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-selector-tag,
|
||||||
|
.hljs-symbol {
|
||||||
|
color: #ff7733;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-name {
|
||||||
|
color: #36a3d9;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-tag {
|
||||||
|
color: #00568d;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-emphasis {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
color: #91b362;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
color: #d96c75;
|
||||||
|
}
|
||||||
660
0.2.0/book.js
Normal file
660
0.2.0/book.js
Normal file
|
|
@ -0,0 +1,660 @@
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
// Fix back button cache problem
|
||||||
|
window.onunload = function () { };
|
||||||
|
|
||||||
|
// Global variable, shared between modules
|
||||||
|
function playground_text(playground) {
|
||||||
|
let code_block = playground.querySelector("code");
|
||||||
|
|
||||||
|
if (window.ace && code_block.classList.contains("editable")) {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
return editor.getValue();
|
||||||
|
} else {
|
||||||
|
return code_block.textContent;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
(function codeSnippets() {
|
||||||
|
function fetch_with_timeout(url, options, timeout = 6000) {
|
||||||
|
return Promise.race([
|
||||||
|
fetch(url, options),
|
||||||
|
new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), timeout))
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
var playgrounds = Array.from(document.querySelectorAll(".playground"));
|
||||||
|
if (playgrounds.length > 0) {
|
||||||
|
fetch_with_timeout("https://play.rust-lang.org/meta/crates", {
|
||||||
|
headers: {
|
||||||
|
'Content-Type': "application/json",
|
||||||
|
},
|
||||||
|
method: 'POST',
|
||||||
|
mode: 'cors',
|
||||||
|
})
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(response => {
|
||||||
|
// get list of crates available in the rust playground
|
||||||
|
let playground_crates = response.crates.map(item => item["id"]);
|
||||||
|
playgrounds.forEach(block => handle_crate_list_update(block, playground_crates));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function handle_crate_list_update(playground_block, playground_crates) {
|
||||||
|
// update the play buttons after receiving the response
|
||||||
|
update_play_button(playground_block, playground_crates);
|
||||||
|
|
||||||
|
// and install on change listener to dynamically update ACE editors
|
||||||
|
if (window.ace) {
|
||||||
|
let code_block = playground_block.querySelector("code");
|
||||||
|
if (code_block.classList.contains("editable")) {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
editor.addEventListener("change", function (e) {
|
||||||
|
update_play_button(playground_block, playground_crates);
|
||||||
|
});
|
||||||
|
// add Ctrl-Enter command to execute rust code
|
||||||
|
editor.commands.addCommand({
|
||||||
|
name: "run",
|
||||||
|
bindKey: {
|
||||||
|
win: "Ctrl-Enter",
|
||||||
|
mac: "Ctrl-Enter"
|
||||||
|
},
|
||||||
|
exec: _editor => run_rust_code(playground_block)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// updates the visibility of play button based on `no_run` class and
|
||||||
|
// used crates vs ones available on http://play.rust-lang.org
|
||||||
|
function update_play_button(pre_block, playground_crates) {
|
||||||
|
var play_button = pre_block.querySelector(".play-button");
|
||||||
|
|
||||||
|
// skip if code is `no_run`
|
||||||
|
if (pre_block.querySelector('code').classList.contains("no_run")) {
|
||||||
|
play_button.classList.add("hidden");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// get list of `extern crate`'s from snippet
|
||||||
|
var txt = playground_text(pre_block);
|
||||||
|
var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
|
||||||
|
var snippet_crates = [];
|
||||||
|
var item;
|
||||||
|
while (item = re.exec(txt)) {
|
||||||
|
snippet_crates.push(item[1]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if all used crates are available on play.rust-lang.org
|
||||||
|
var all_available = snippet_crates.every(function (elem) {
|
||||||
|
return playground_crates.indexOf(elem) > -1;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (all_available) {
|
||||||
|
play_button.classList.remove("hidden");
|
||||||
|
} else {
|
||||||
|
play_button.classList.add("hidden");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function run_rust_code(code_block) {
|
||||||
|
var result_block = code_block.querySelector(".result");
|
||||||
|
if (!result_block) {
|
||||||
|
result_block = document.createElement('code');
|
||||||
|
result_block.className = 'result hljs language-bash';
|
||||||
|
|
||||||
|
code_block.append(result_block);
|
||||||
|
}
|
||||||
|
|
||||||
|
let text = playground_text(code_block);
|
||||||
|
let classes = code_block.querySelector('code').classList;
|
||||||
|
let has_2018 = classes.contains("edition2018");
|
||||||
|
let edition = has_2018 ? "2018" : "2015";
|
||||||
|
|
||||||
|
var params = {
|
||||||
|
version: "stable",
|
||||||
|
optimize: "0",
|
||||||
|
code: text,
|
||||||
|
edition: edition
|
||||||
|
};
|
||||||
|
|
||||||
|
if (text.indexOf("#![feature") !== -1) {
|
||||||
|
params.version = "nightly";
|
||||||
|
}
|
||||||
|
|
||||||
|
result_block.innerText = "Running...";
|
||||||
|
|
||||||
|
fetch_with_timeout("https://play.rust-lang.org/evaluate.json", {
|
||||||
|
headers: {
|
||||||
|
'Content-Type': "application/json",
|
||||||
|
},
|
||||||
|
method: 'POST',
|
||||||
|
mode: 'cors',
|
||||||
|
body: JSON.stringify(params)
|
||||||
|
})
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(response => result_block.innerText = response.result)
|
||||||
|
.catch(error => result_block.innerText = "Playground Communication: " + error.message);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Syntax highlighting Configuration
|
||||||
|
hljs.configure({
|
||||||
|
tabReplace: ' ', // 4 spaces
|
||||||
|
languages: [], // Languages used for auto-detection
|
||||||
|
});
|
||||||
|
|
||||||
|
let code_nodes = Array
|
||||||
|
.from(document.querySelectorAll('code'))
|
||||||
|
// Don't highlight `inline code` blocks in headers.
|
||||||
|
.filter(function (node) {return !node.parentElement.classList.contains("header"); });
|
||||||
|
|
||||||
|
if (window.ace) {
|
||||||
|
// language-rust class needs to be removed for editable
|
||||||
|
// blocks or highlightjs will capture events
|
||||||
|
Array
|
||||||
|
.from(document.querySelectorAll('code.editable'))
|
||||||
|
.forEach(function (block) { block.classList.remove('language-rust'); });
|
||||||
|
|
||||||
|
Array
|
||||||
|
.from(document.querySelectorAll('code:not(.editable)'))
|
||||||
|
.forEach(function (block) { hljs.highlightBlock(block); });
|
||||||
|
} else {
|
||||||
|
code_nodes.forEach(function (block) { hljs.highlightBlock(block); });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Adding the hljs class gives code blocks the color css
|
||||||
|
// even if highlighting doesn't apply
|
||||||
|
code_nodes.forEach(function (block) { block.classList.add('hljs'); });
|
||||||
|
|
||||||
|
Array.from(document.querySelectorAll("code.language-rust")).forEach(function (block) {
|
||||||
|
|
||||||
|
var lines = Array.from(block.querySelectorAll('.boring'));
|
||||||
|
// If no lines were hidden, return
|
||||||
|
if (!lines.length) { return; }
|
||||||
|
block.classList.add("hide-boring");
|
||||||
|
|
||||||
|
var buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
buttons.innerHTML = "<button class=\"fa fa-eye\" title=\"Show hidden lines\" aria-label=\"Show hidden lines\"></button>";
|
||||||
|
|
||||||
|
// add expand button
|
||||||
|
var pre_block = block.parentNode;
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
|
||||||
|
pre_block.querySelector('.buttons').addEventListener('click', function (e) {
|
||||||
|
if (e.target.classList.contains('fa-eye')) {
|
||||||
|
e.target.classList.remove('fa-eye');
|
||||||
|
e.target.classList.add('fa-eye-slash');
|
||||||
|
e.target.title = 'Hide lines';
|
||||||
|
e.target.setAttribute('aria-label', e.target.title);
|
||||||
|
|
||||||
|
block.classList.remove('hide-boring');
|
||||||
|
} else if (e.target.classList.contains('fa-eye-slash')) {
|
||||||
|
e.target.classList.remove('fa-eye-slash');
|
||||||
|
e.target.classList.add('fa-eye');
|
||||||
|
e.target.title = 'Show hidden lines';
|
||||||
|
e.target.setAttribute('aria-label', e.target.title);
|
||||||
|
|
||||||
|
block.classList.add('hide-boring');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
if (window.playground_copyable) {
|
||||||
|
Array.from(document.querySelectorAll('pre code')).forEach(function (block) {
|
||||||
|
var pre_block = block.parentNode;
|
||||||
|
if (!pre_block.classList.contains('playground')) {
|
||||||
|
var buttons = pre_block.querySelector(".buttons");
|
||||||
|
if (!buttons) {
|
||||||
|
buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
var clipButton = document.createElement('button');
|
||||||
|
clipButton.className = 'fa fa-copy clip-button';
|
||||||
|
clipButton.title = 'Copy to clipboard';
|
||||||
|
clipButton.setAttribute('aria-label', clipButton.title);
|
||||||
|
clipButton.innerHTML = '<i class=\"tooltiptext\"></i>';
|
||||||
|
|
||||||
|
buttons.insertBefore(clipButton, buttons.firstChild);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process playground code blocks
|
||||||
|
Array.from(document.querySelectorAll(".playground")).forEach(function (pre_block) {
|
||||||
|
// Add play button
|
||||||
|
var buttons = pre_block.querySelector(".buttons");
|
||||||
|
if (!buttons) {
|
||||||
|
buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
var runCodeButton = document.createElement('button');
|
||||||
|
runCodeButton.className = 'fa fa-play play-button';
|
||||||
|
runCodeButton.hidden = true;
|
||||||
|
runCodeButton.title = 'Run this code';
|
||||||
|
runCodeButton.setAttribute('aria-label', runCodeButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(runCodeButton, buttons.firstChild);
|
||||||
|
runCodeButton.addEventListener('click', function (e) {
|
||||||
|
run_rust_code(pre_block);
|
||||||
|
});
|
||||||
|
|
||||||
|
if (window.playground_copyable) {
|
||||||
|
var copyCodeClipboardButton = document.createElement('button');
|
||||||
|
copyCodeClipboardButton.className = 'fa fa-copy clip-button';
|
||||||
|
copyCodeClipboardButton.innerHTML = '<i class="tooltiptext"></i>';
|
||||||
|
copyCodeClipboardButton.title = 'Copy to clipboard';
|
||||||
|
copyCodeClipboardButton.setAttribute('aria-label', copyCodeClipboardButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(copyCodeClipboardButton, buttons.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
let code_block = pre_block.querySelector("code");
|
||||||
|
if (window.ace && code_block.classList.contains("editable")) {
|
||||||
|
var undoChangesButton = document.createElement('button');
|
||||||
|
undoChangesButton.className = 'fa fa-history reset-button';
|
||||||
|
undoChangesButton.title = 'Undo changes';
|
||||||
|
undoChangesButton.setAttribute('aria-label', undoChangesButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(undoChangesButton, buttons.firstChild);
|
||||||
|
|
||||||
|
undoChangesButton.addEventListener('click', function () {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
editor.setValue(editor.originalCode);
|
||||||
|
editor.clearSelection();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function themes() {
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var themeToggleButton = document.getElementById('theme-toggle');
|
||||||
|
var themePopup = document.getElementById('theme-list');
|
||||||
|
var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
|
||||||
|
var stylesheets = {
|
||||||
|
ayuHighlight: document.querySelector("[href$='ayu-highlight.css']"),
|
||||||
|
tomorrowNight: document.querySelector("[href$='tomorrow-night.css']"),
|
||||||
|
highlight: document.querySelector("[href$='highlight.css']"),
|
||||||
|
};
|
||||||
|
|
||||||
|
function showThemes() {
|
||||||
|
themePopup.style.display = 'block';
|
||||||
|
themeToggleButton.setAttribute('aria-expanded', true);
|
||||||
|
themePopup.querySelector("button#" + get_theme()).focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
function hideThemes() {
|
||||||
|
themePopup.style.display = 'none';
|
||||||
|
themeToggleButton.setAttribute('aria-expanded', false);
|
||||||
|
themeToggleButton.focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_theme() {
|
||||||
|
var theme;
|
||||||
|
try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
|
||||||
|
if (theme === null || theme === undefined) {
|
||||||
|
return default_theme;
|
||||||
|
} else {
|
||||||
|
return theme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function set_theme(theme, store = true) {
|
||||||
|
let ace_theme;
|
||||||
|
|
||||||
|
if (theme == 'coal' || theme == 'navy') {
|
||||||
|
stylesheets.ayuHighlight.disabled = true;
|
||||||
|
stylesheets.tomorrowNight.disabled = false;
|
||||||
|
stylesheets.highlight.disabled = true;
|
||||||
|
|
||||||
|
ace_theme = "ace/theme/tomorrow_night";
|
||||||
|
} else if (theme == 'ayu') {
|
||||||
|
stylesheets.ayuHighlight.disabled = false;
|
||||||
|
stylesheets.tomorrowNight.disabled = true;
|
||||||
|
stylesheets.highlight.disabled = true;
|
||||||
|
ace_theme = "ace/theme/tomorrow_night";
|
||||||
|
} else {
|
||||||
|
stylesheets.ayuHighlight.disabled = true;
|
||||||
|
stylesheets.tomorrowNight.disabled = true;
|
||||||
|
stylesheets.highlight.disabled = false;
|
||||||
|
ace_theme = "ace/theme/dawn";
|
||||||
|
}
|
||||||
|
|
||||||
|
setTimeout(function () {
|
||||||
|
themeColorMetaTag.content = getComputedStyle(document.body).backgroundColor;
|
||||||
|
}, 1);
|
||||||
|
|
||||||
|
if (window.ace && window.editors) {
|
||||||
|
window.editors.forEach(function (editor) {
|
||||||
|
editor.setTheme(ace_theme);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
var previousTheme = get_theme();
|
||||||
|
|
||||||
|
if (store) {
|
||||||
|
try { localStorage.setItem('mdbook-theme', theme); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
html.classList.remove(previousTheme);
|
||||||
|
html.classList.add(theme);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set theme
|
||||||
|
var theme = get_theme();
|
||||||
|
|
||||||
|
set_theme(theme, false);
|
||||||
|
|
||||||
|
themeToggleButton.addEventListener('click', function () {
|
||||||
|
if (themePopup.style.display === 'block') {
|
||||||
|
hideThemes();
|
||||||
|
} else {
|
||||||
|
showThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
themePopup.addEventListener('click', function (e) {
|
||||||
|
var theme = e.target.id || e.target.parentElement.id;
|
||||||
|
set_theme(theme);
|
||||||
|
});
|
||||||
|
|
||||||
|
themePopup.addEventListener('focusout', function(e) {
|
||||||
|
// e.relatedTarget is null in Safari and Firefox on macOS (see workaround below)
|
||||||
|
if (!!e.relatedTarget && !themeToggleButton.contains(e.relatedTarget) && !themePopup.contains(e.relatedTarget)) {
|
||||||
|
hideThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
|
||||||
|
document.addEventListener('click', function(e) {
|
||||||
|
if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
|
||||||
|
hideThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
document.addEventListener('keydown', function (e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
|
||||||
|
if (!themePopup.contains(e.target)) { return; }
|
||||||
|
|
||||||
|
switch (e.key) {
|
||||||
|
case 'Escape':
|
||||||
|
e.preventDefault();
|
||||||
|
hideThemes();
|
||||||
|
break;
|
||||||
|
case 'ArrowUp':
|
||||||
|
e.preventDefault();
|
||||||
|
var li = document.activeElement.parentElement;
|
||||||
|
if (li && li.previousElementSibling) {
|
||||||
|
li.previousElementSibling.querySelector('button').focus();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'ArrowDown':
|
||||||
|
e.preventDefault();
|
||||||
|
var li = document.activeElement.parentElement;
|
||||||
|
if (li && li.nextElementSibling) {
|
||||||
|
li.nextElementSibling.querySelector('button').focus();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'Home':
|
||||||
|
e.preventDefault();
|
||||||
|
themePopup.querySelector('li:first-child button').focus();
|
||||||
|
break;
|
||||||
|
case 'End':
|
||||||
|
e.preventDefault();
|
||||||
|
themePopup.querySelector('li:last-child button').focus();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function sidebar() {
|
||||||
|
var html = document.querySelector("html");
|
||||||
|
var sidebar = document.getElementById("sidebar");
|
||||||
|
var sidebarLinks = document.querySelectorAll('#sidebar a');
|
||||||
|
var sidebarToggleButton = document.getElementById("sidebar-toggle");
|
||||||
|
var sidebarResizeHandle = document.getElementById("sidebar-resize-handle");
|
||||||
|
var firstContact = null;
|
||||||
|
|
||||||
|
function showSidebar() {
|
||||||
|
html.classList.remove('sidebar-hidden')
|
||||||
|
html.classList.add('sidebar-visible');
|
||||||
|
Array.from(sidebarLinks).forEach(function (link) {
|
||||||
|
link.setAttribute('tabIndex', 0);
|
||||||
|
});
|
||||||
|
sidebarToggleButton.setAttribute('aria-expanded', true);
|
||||||
|
sidebar.setAttribute('aria-hidden', false);
|
||||||
|
try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
|
||||||
|
|
||||||
|
function toggleSection(ev) {
|
||||||
|
ev.currentTarget.parentElement.classList.toggle('expanded');
|
||||||
|
}
|
||||||
|
|
||||||
|
Array.from(sidebarAnchorToggles).forEach(function (el) {
|
||||||
|
el.addEventListener('click', toggleSection);
|
||||||
|
});
|
||||||
|
|
||||||
|
function hideSidebar() {
|
||||||
|
html.classList.remove('sidebar-visible')
|
||||||
|
html.classList.add('sidebar-hidden');
|
||||||
|
Array.from(sidebarLinks).forEach(function (link) {
|
||||||
|
link.setAttribute('tabIndex', -1);
|
||||||
|
});
|
||||||
|
sidebarToggleButton.setAttribute('aria-expanded', false);
|
||||||
|
sidebar.setAttribute('aria-hidden', true);
|
||||||
|
try { localStorage.setItem('mdbook-sidebar', 'hidden'); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
// Toggle sidebar
|
||||||
|
sidebarToggleButton.addEventListener('click', function sidebarToggle() {
|
||||||
|
if (html.classList.contains("sidebar-hidden")) {
|
||||||
|
var current_width = parseInt(
|
||||||
|
document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
|
||||||
|
if (current_width < 150) {
|
||||||
|
document.documentElement.style.setProperty('--sidebar-width', '150px');
|
||||||
|
}
|
||||||
|
showSidebar();
|
||||||
|
} else if (html.classList.contains("sidebar-visible")) {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
if (getComputedStyle(sidebar)['transform'] === 'none') {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
showSidebar();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
sidebarResizeHandle.addEventListener('mousedown', initResize, false);
|
||||||
|
|
||||||
|
function initResize(e) {
|
||||||
|
window.addEventListener('mousemove', resize, false);
|
||||||
|
window.addEventListener('mouseup', stopResize, false);
|
||||||
|
html.classList.add('sidebar-resizing');
|
||||||
|
}
|
||||||
|
function resize(e) {
|
||||||
|
var pos = (e.clientX - sidebar.offsetLeft);
|
||||||
|
if (pos < 20) {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
if (html.classList.contains("sidebar-hidden")) {
|
||||||
|
showSidebar();
|
||||||
|
}
|
||||||
|
pos = Math.min(pos, window.innerWidth - 100);
|
||||||
|
document.documentElement.style.setProperty('--sidebar-width', pos + 'px');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//on mouseup remove windows functions mousemove & mouseup
|
||||||
|
function stopResize(e) {
|
||||||
|
html.classList.remove('sidebar-resizing');
|
||||||
|
window.removeEventListener('mousemove', resize, false);
|
||||||
|
window.removeEventListener('mouseup', stopResize, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
document.addEventListener('touchstart', function (e) {
|
||||||
|
firstContact = {
|
||||||
|
x: e.touches[0].clientX,
|
||||||
|
time: Date.now()
|
||||||
|
};
|
||||||
|
}, { passive: true });
|
||||||
|
|
||||||
|
document.addEventListener('touchmove', function (e) {
|
||||||
|
if (!firstContact)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var curX = e.touches[0].clientX;
|
||||||
|
var xDiff = curX - firstContact.x,
|
||||||
|
tDiff = Date.now() - firstContact.time;
|
||||||
|
|
||||||
|
if (tDiff < 250 && Math.abs(xDiff) >= 150) {
|
||||||
|
if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
|
||||||
|
showSidebar();
|
||||||
|
else if (xDiff < 0 && curX < 300)
|
||||||
|
hideSidebar();
|
||||||
|
|
||||||
|
firstContact = null;
|
||||||
|
}
|
||||||
|
}, { passive: true });
|
||||||
|
|
||||||
|
// Scroll sidebar to current active section
|
||||||
|
var activeSection = document.getElementById("sidebar").querySelector(".active");
|
||||||
|
if (activeSection) {
|
||||||
|
// https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
|
||||||
|
activeSection.scrollIntoView({ block: 'center' });
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function chapterNavigation() {
|
||||||
|
document.addEventListener('keydown', function (e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
|
||||||
|
if (window.search && window.search.hasFocus()) { return; }
|
||||||
|
|
||||||
|
switch (e.key) {
|
||||||
|
case 'ArrowRight':
|
||||||
|
e.preventDefault();
|
||||||
|
var nextButton = document.querySelector('.nav-chapters.next');
|
||||||
|
if (nextButton) {
|
||||||
|
window.location.href = nextButton.href;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'ArrowLeft':
|
||||||
|
e.preventDefault();
|
||||||
|
var previousButton = document.querySelector('.nav-chapters.previous');
|
||||||
|
if (previousButton) {
|
||||||
|
window.location.href = previousButton.href;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function clipboard() {
|
||||||
|
var clipButtons = document.querySelectorAll('.clip-button');
|
||||||
|
|
||||||
|
function hideTooltip(elem) {
|
||||||
|
elem.firstChild.innerText = "";
|
||||||
|
elem.className = 'fa fa-copy clip-button';
|
||||||
|
}
|
||||||
|
|
||||||
|
function showTooltip(elem, msg) {
|
||||||
|
elem.firstChild.innerText = msg;
|
||||||
|
elem.className = 'fa fa-copy tooltipped';
|
||||||
|
}
|
||||||
|
|
||||||
|
var clipboardSnippets = new ClipboardJS('.clip-button', {
|
||||||
|
text: function (trigger) {
|
||||||
|
hideTooltip(trigger);
|
||||||
|
let playground = trigger.closest("pre");
|
||||||
|
return playground_text(playground);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
Array.from(clipButtons).forEach(function (clipButton) {
|
||||||
|
clipButton.addEventListener('mouseout', function (e) {
|
||||||
|
hideTooltip(e.currentTarget);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
clipboardSnippets.on('success', function (e) {
|
||||||
|
e.clearSelection();
|
||||||
|
showTooltip(e.trigger, "Copied!");
|
||||||
|
});
|
||||||
|
|
||||||
|
clipboardSnippets.on('error', function (e) {
|
||||||
|
showTooltip(e.trigger, "Clipboard error!");
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function scrollToTop () {
|
||||||
|
var menuTitle = document.querySelector('.menu-title');
|
||||||
|
|
||||||
|
menuTitle.addEventListener('click', function () {
|
||||||
|
document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function controllMenu() {
|
||||||
|
var menu = document.getElementById('menu-bar');
|
||||||
|
|
||||||
|
(function controllPosition() {
|
||||||
|
var scrollTop = document.scrollingElement.scrollTop;
|
||||||
|
var prevScrollTop = scrollTop;
|
||||||
|
var minMenuY = -menu.clientHeight - 50;
|
||||||
|
// When the script loads, the page can be at any scroll (e.g. if you reforesh it).
|
||||||
|
menu.style.top = scrollTop + 'px';
|
||||||
|
// Same as parseInt(menu.style.top.slice(0, -2), but faster
|
||||||
|
var topCache = menu.style.top.slice(0, -2);
|
||||||
|
menu.classList.remove('sticky');
|
||||||
|
var stickyCache = false; // Same as menu.classList.contains('sticky'), but faster
|
||||||
|
document.addEventListener('scroll', function () {
|
||||||
|
scrollTop = Math.max(document.scrollingElement.scrollTop, 0);
|
||||||
|
// `null` means that it doesn't need to be updated
|
||||||
|
var nextSticky = null;
|
||||||
|
var nextTop = null;
|
||||||
|
var scrollDown = scrollTop > prevScrollTop;
|
||||||
|
var menuPosAbsoluteY = topCache - scrollTop;
|
||||||
|
if (scrollDown) {
|
||||||
|
nextSticky = false;
|
||||||
|
if (menuPosAbsoluteY > 0) {
|
||||||
|
nextTop = prevScrollTop;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (menuPosAbsoluteY > 0) {
|
||||||
|
nextSticky = true;
|
||||||
|
} else if (menuPosAbsoluteY < minMenuY) {
|
||||||
|
nextTop = prevScrollTop + minMenuY;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (nextSticky === true && stickyCache === false) {
|
||||||
|
menu.classList.add('sticky');
|
||||||
|
stickyCache = true;
|
||||||
|
} else if (nextSticky === false && stickyCache === true) {
|
||||||
|
menu.classList.remove('sticky');
|
||||||
|
stickyCache = false;
|
||||||
|
}
|
||||||
|
if (nextTop !== null) {
|
||||||
|
menu.style.top = nextTop + 'px';
|
||||||
|
topCache = nextTop;
|
||||||
|
}
|
||||||
|
prevScrollTop = scrollTop;
|
||||||
|
}, { passive: true });
|
||||||
|
})();
|
||||||
|
(function controllBorder() {
|
||||||
|
menu.classList.remove('bordered');
|
||||||
|
document.addEventListener('scroll', function () {
|
||||||
|
if (menu.offsetTop === 0) {
|
||||||
|
menu.classList.remove('bordered');
|
||||||
|
} else {
|
||||||
|
menu.classList.add('bordered');
|
||||||
|
}
|
||||||
|
}, { passive: true });
|
||||||
|
})();
|
||||||
|
})();
|
||||||
7
0.2.0/clipboard.min.js
vendored
Normal file
7
0.2.0/clipboard.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
495
0.2.0/css/chrome.css
Normal file
495
0.2.0/css/chrome.css
Normal file
|
|
@ -0,0 +1,495 @@
|
||||||
|
/* CSS for UI elements (a.k.a. chrome) */
|
||||||
|
|
||||||
|
@import 'variables.css';
|
||||||
|
|
||||||
|
::-webkit-scrollbar {
|
||||||
|
background: var(--bg);
|
||||||
|
}
|
||||||
|
::-webkit-scrollbar-thumb {
|
||||||
|
background: var(--scrollbar);
|
||||||
|
}
|
||||||
|
html {
|
||||||
|
scrollbar-color: var(--scrollbar) var(--bg);
|
||||||
|
}
|
||||||
|
#searchresults a,
|
||||||
|
.content a:link,
|
||||||
|
a:visited,
|
||||||
|
a > .hljs {
|
||||||
|
color: var(--links);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Menu Bar */
|
||||||
|
|
||||||
|
#menu-bar,
|
||||||
|
#menu-bar-hover-placeholder {
|
||||||
|
z-index: 101;
|
||||||
|
margin: auto calc(0px - var(--page-padding));
|
||||||
|
}
|
||||||
|
#menu-bar {
|
||||||
|
position: relative;
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
background-color: var(--bg);
|
||||||
|
border-bottom-color: var(--bg);
|
||||||
|
border-bottom-width: 1px;
|
||||||
|
border-bottom-style: solid;
|
||||||
|
}
|
||||||
|
#menu-bar.sticky,
|
||||||
|
.js #menu-bar-hover-placeholder:hover + #menu-bar,
|
||||||
|
.js #menu-bar:hover,
|
||||||
|
.js.sidebar-visible #menu-bar {
|
||||||
|
position: -webkit-sticky;
|
||||||
|
position: sticky;
|
||||||
|
top: 0 !important;
|
||||||
|
}
|
||||||
|
#menu-bar-hover-placeholder {
|
||||||
|
position: sticky;
|
||||||
|
position: -webkit-sticky;
|
||||||
|
top: 0;
|
||||||
|
height: var(--menu-bar-height);
|
||||||
|
}
|
||||||
|
#menu-bar.bordered {
|
||||||
|
border-bottom-color: var(--table-border-color);
|
||||||
|
}
|
||||||
|
#menu-bar i, #menu-bar .icon-button {
|
||||||
|
position: relative;
|
||||||
|
padding: 0 8px;
|
||||||
|
z-index: 10;
|
||||||
|
line-height: var(--menu-bar-height);
|
||||||
|
cursor: pointer;
|
||||||
|
transition: color 0.5s;
|
||||||
|
}
|
||||||
|
@media only screen and (max-width: 420px) {
|
||||||
|
#menu-bar i, #menu-bar .icon-button {
|
||||||
|
padding: 0 5px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon-button {
|
||||||
|
border: none;
|
||||||
|
background: none;
|
||||||
|
padding: 0;
|
||||||
|
color: inherit;
|
||||||
|
}
|
||||||
|
.icon-button i {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.right-buttons {
|
||||||
|
margin: 0 15px;
|
||||||
|
}
|
||||||
|
.right-buttons a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left-buttons {
|
||||||
|
display: flex;
|
||||||
|
margin: 0 5px;
|
||||||
|
}
|
||||||
|
.no-js .left-buttons {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-title {
|
||||||
|
display: inline-block;
|
||||||
|
font-weight: 200;
|
||||||
|
font-size: 2.4rem;
|
||||||
|
line-height: var(--menu-bar-height);
|
||||||
|
text-align: center;
|
||||||
|
margin: 0;
|
||||||
|
flex: 1;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
.js .menu-title {
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-bar,
|
||||||
|
.menu-bar:visited,
|
||||||
|
.nav-chapters,
|
||||||
|
.nav-chapters:visited,
|
||||||
|
.mobile-nav-chapters,
|
||||||
|
.mobile-nav-chapters:visited,
|
||||||
|
.menu-bar .icon-button,
|
||||||
|
.menu-bar a i {
|
||||||
|
color: var(--icons);
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-bar i:hover,
|
||||||
|
.menu-bar .icon-button:hover,
|
||||||
|
.nav-chapters:hover,
|
||||||
|
.mobile-nav-chapters i:hover {
|
||||||
|
color: var(--icons-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Nav Icons */
|
||||||
|
|
||||||
|
.nav-chapters {
|
||||||
|
font-size: 2.5em;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
margin: 0;
|
||||||
|
max-width: 150px;
|
||||||
|
min-width: 90px;
|
||||||
|
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
align-content: center;
|
||||||
|
flex-direction: column;
|
||||||
|
|
||||||
|
transition: color 0.5s, background-color 0.5s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-chapters:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
background-color: var(--theme-hover);
|
||||||
|
transition: background-color 0.15s, color 0.15s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-wrapper {
|
||||||
|
margin-top: 50px;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mobile-nav-chapters {
|
||||||
|
font-size: 2.5em;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
width: 90px;
|
||||||
|
border-radius: 5px;
|
||||||
|
background-color: var(--sidebar-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.previous {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.next {
|
||||||
|
float: right;
|
||||||
|
right: var(--page-padding);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media only screen and (max-width: 1080px) {
|
||||||
|
.nav-wide-wrapper { display: none; }
|
||||||
|
.nav-wrapper { display: block; }
|
||||||
|
}
|
||||||
|
|
||||||
|
@media only screen and (max-width: 1380px) {
|
||||||
|
.sidebar-visible .nav-wide-wrapper { display: none; }
|
||||||
|
.sidebar-visible .nav-wrapper { display: block; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Inline code */
|
||||||
|
|
||||||
|
:not(pre) > .hljs {
|
||||||
|
display: inline;
|
||||||
|
padding: 0.1em 0.3em;
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
:not(pre):not(a) > .hljs {
|
||||||
|
color: var(--inline-code-color);
|
||||||
|
overflow-x: initial;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover > .hljs {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
pre > .buttons {
|
||||||
|
position: absolute;
|
||||||
|
z-index: 100;
|
||||||
|
right: 5px;
|
||||||
|
top: 5px;
|
||||||
|
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
pre > .buttons :hover {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
pre > .buttons i {
|
||||||
|
margin-left: 8px;
|
||||||
|
}
|
||||||
|
pre > .buttons button {
|
||||||
|
color: inherit;
|
||||||
|
background: transparent;
|
||||||
|
border: none;
|
||||||
|
cursor: inherit;
|
||||||
|
}
|
||||||
|
pre > .result {
|
||||||
|
margin-top: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Search */
|
||||||
|
|
||||||
|
#searchresults a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
mark {
|
||||||
|
border-radius: 2px;
|
||||||
|
padding: 0 3px 1px 3px;
|
||||||
|
margin: 0 -3px -1px -3px;
|
||||||
|
background-color: var(--search-mark-bg);
|
||||||
|
transition: background-color 300ms linear;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
mark.fade-out {
|
||||||
|
background-color: rgba(0,0,0,0) !important;
|
||||||
|
cursor: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchbar-outer {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
}
|
||||||
|
|
||||||
|
#searchbar {
|
||||||
|
width: 100%;
|
||||||
|
margin: 5px auto 0px auto;
|
||||||
|
padding: 10px 16px;
|
||||||
|
transition: box-shadow 300ms ease-in-out;
|
||||||
|
border: 1px solid var(--searchbar-border-color);
|
||||||
|
border-radius: 3px;
|
||||||
|
background-color: var(--searchbar-bg);
|
||||||
|
color: var(--searchbar-fg);
|
||||||
|
}
|
||||||
|
#searchbar:focus,
|
||||||
|
#searchbar.active {
|
||||||
|
box-shadow: 0 0 3px var(--searchbar-shadow-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchresults-header {
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 1em;
|
||||||
|
padding: 18px 0 0 5px;
|
||||||
|
color: var(--searchresults-header-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchresults-outer {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
border-bottom: 1px dashed var(--searchresults-border-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
ul#searchresults {
|
||||||
|
list-style: none;
|
||||||
|
padding-left: 20px;
|
||||||
|
}
|
||||||
|
ul#searchresults li {
|
||||||
|
margin: 10px 0px;
|
||||||
|
padding: 2px;
|
||||||
|
border-radius: 2px;
|
||||||
|
}
|
||||||
|
ul#searchresults li.focus {
|
||||||
|
background-color: var(--searchresults-li-bg);
|
||||||
|
}
|
||||||
|
ul#searchresults span.teaser {
|
||||||
|
display: block;
|
||||||
|
clear: both;
|
||||||
|
margin: 5px 0 0 20px;
|
||||||
|
font-size: 0.8em;
|
||||||
|
}
|
||||||
|
ul#searchresults span.teaser em {
|
||||||
|
font-weight: bold;
|
||||||
|
font-style: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Sidebar */
|
||||||
|
|
||||||
|
.sidebar {
|
||||||
|
position: fixed;
|
||||||
|
left: 0;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
width: var(--sidebar-width);
|
||||||
|
font-size: 0.875em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
-webkit-overflow-scrolling: touch;
|
||||||
|
overscroll-behavior-y: contain;
|
||||||
|
background-color: var(--sidebar-bg);
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
}
|
||||||
|
.sidebar-resizing {
|
||||||
|
-moz-user-select: none;
|
||||||
|
-webkit-user-select: none;
|
||||||
|
-ms-user-select: none;
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
.js:not(.sidebar-resizing) .sidebar {
|
||||||
|
transition: transform 0.3s; /* Animation: slide away */
|
||||||
|
}
|
||||||
|
.sidebar code {
|
||||||
|
line-height: 2em;
|
||||||
|
}
|
||||||
|
.sidebar .sidebar-scrollbox {
|
||||||
|
overflow-y: auto;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
left: 0;
|
||||||
|
right: 0;
|
||||||
|
padding: 10px 10px;
|
||||||
|
}
|
||||||
|
.sidebar .sidebar-resize-handle {
|
||||||
|
position: absolute;
|
||||||
|
cursor: col-resize;
|
||||||
|
width: 0;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
}
|
||||||
|
.js .sidebar .sidebar-resize-handle {
|
||||||
|
cursor: col-resize;
|
||||||
|
width: 5px;
|
||||||
|
}
|
||||||
|
.sidebar-hidden .sidebar {
|
||||||
|
transform: translateX(calc(0px - var(--sidebar-width)));
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar {
|
||||||
|
background: var(--sidebar-bg);
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar-thumb {
|
||||||
|
background: var(--scrollbar);
|
||||||
|
}
|
||||||
|
|
||||||
|
.sidebar-visible .page-wrapper {
|
||||||
|
transform: translateX(var(--sidebar-width));
|
||||||
|
}
|
||||||
|
@media only screen and (min-width: 620px) {
|
||||||
|
.sidebar-visible .page-wrapper {
|
||||||
|
transform: none;
|
||||||
|
margin-left: var(--sidebar-width);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter {
|
||||||
|
list-style: none outside none;
|
||||||
|
padding-left: 0;
|
||||||
|
line-height: 2.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter ol {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li {
|
||||||
|
display: flex;
|
||||||
|
color: var(--sidebar-non-existant);
|
||||||
|
}
|
||||||
|
.chapter li a {
|
||||||
|
display: block;
|
||||||
|
padding: 0;
|
||||||
|
text-decoration: none;
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li a:hover {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li a.active {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li > a.toggle {
|
||||||
|
cursor: pointer;
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
padding: 0 10px;
|
||||||
|
user-select: none;
|
||||||
|
opacity: 0.68;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li > a.toggle div {
|
||||||
|
transition: transform 0.5s;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* collapse the section */
|
||||||
|
.chapter li:not(.expanded) + li > ol {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.chapter-item {
|
||||||
|
line-height: 1.5em;
|
||||||
|
margin-top: 0.6em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.expanded > a.toggle div {
|
||||||
|
transform: rotate(90deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.spacer {
|
||||||
|
width: 100%;
|
||||||
|
height: 3px;
|
||||||
|
margin: 5px 0px;
|
||||||
|
}
|
||||||
|
.chapter .spacer {
|
||||||
|
background-color: var(--sidebar-spacer);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (-moz-touch-enabled: 1), (pointer: coarse) {
|
||||||
|
.chapter li a { padding: 5px 0; }
|
||||||
|
.spacer { margin: 10px 0; }
|
||||||
|
}
|
||||||
|
|
||||||
|
.section {
|
||||||
|
list-style: none outside none;
|
||||||
|
padding-left: 20px;
|
||||||
|
line-height: 1.9em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Theme Menu Popup */
|
||||||
|
|
||||||
|
.theme-popup {
|
||||||
|
position: absolute;
|
||||||
|
left: 10px;
|
||||||
|
top: var(--menu-bar-height);
|
||||||
|
z-index: 1000;
|
||||||
|
border-radius: 4px;
|
||||||
|
font-size: 0.7em;
|
||||||
|
color: var(--fg);
|
||||||
|
background: var(--theme-popup-bg);
|
||||||
|
border: 1px solid var(--theme-popup-border);
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.theme-popup .default {
|
||||||
|
color: var(--icons);
|
||||||
|
}
|
||||||
|
.theme-popup .theme {
|
||||||
|
width: 100%;
|
||||||
|
border: 0;
|
||||||
|
margin: 0;
|
||||||
|
padding: 2px 10px;
|
||||||
|
line-height: 25px;
|
||||||
|
white-space: nowrap;
|
||||||
|
text-align: left;
|
||||||
|
cursor: pointer;
|
||||||
|
color: inherit;
|
||||||
|
background: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
.theme-popup .theme:hover {
|
||||||
|
background-color: var(--theme-hover);
|
||||||
|
}
|
||||||
|
.theme-popup .theme:hover:first-child,
|
||||||
|
.theme-popup .theme:hover:last-child {
|
||||||
|
border-top-left-radius: inherit;
|
||||||
|
border-top-right-radius: inherit;
|
||||||
|
}
|
||||||
177
0.2.0/css/general.css
Normal file
177
0.2.0/css/general.css
Normal file
|
|
@ -0,0 +1,177 @@
|
||||||
|
/* Base styles and content styles */
|
||||||
|
|
||||||
|
@import 'variables.css';
|
||||||
|
|
||||||
|
:root {
|
||||||
|
/* Browser default font-size is 16px, this way 1 rem = 10px */
|
||||||
|
font-size: 62.5%;
|
||||||
|
}
|
||||||
|
|
||||||
|
html {
|
||||||
|
font-family: "Open Sans", sans-serif;
|
||||||
|
color: var(--fg);
|
||||||
|
background-color: var(--bg);
|
||||||
|
text-size-adjust: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
font-size: 1.6rem;
|
||||||
|
overflow-x: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace !important;
|
||||||
|
font-size: 0.875em; /* please adjust the ace font size accordingly in editor.js */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Don't change font size in headers. */
|
||||||
|
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||||
|
font-size: unset;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left { float: left; }
|
||||||
|
.right { float: right; }
|
||||||
|
.boring { opacity: 0.6; }
|
||||||
|
.hide-boring .boring { display: none; }
|
||||||
|
.hidden { display: none !important; }
|
||||||
|
|
||||||
|
h2, h3 { margin-top: 2.5em; }
|
||||||
|
h4, h5 { margin-top: 2em; }
|
||||||
|
|
||||||
|
.header + .header h3,
|
||||||
|
.header + .header h4,
|
||||||
|
.header + .header h5 {
|
||||||
|
margin-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1:target::before,
|
||||||
|
h2:target::before,
|
||||||
|
h3:target::before,
|
||||||
|
h4:target::before,
|
||||||
|
h5:target::before,
|
||||||
|
h6:target::before {
|
||||||
|
display: inline-block;
|
||||||
|
content: "»";
|
||||||
|
margin-left: -30px;
|
||||||
|
width: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* This is broken on Safari as of version 14, but is fixed
|
||||||
|
in Safari Technology Preview 117 which I think will be Safari 14.2.
|
||||||
|
https://bugs.webkit.org/show_bug.cgi?id=218076
|
||||||
|
*/
|
||||||
|
:target {
|
||||||
|
scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
|
||||||
|
}
|
||||||
|
|
||||||
|
.page {
|
||||||
|
outline: 0;
|
||||||
|
padding: 0 var(--page-padding);
|
||||||
|
margin-top: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
|
||||||
|
}
|
||||||
|
.page-wrapper {
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
.js:not(.sidebar-resizing) .page-wrapper {
|
||||||
|
transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
|
||||||
|
}
|
||||||
|
|
||||||
|
.content {
|
||||||
|
overflow-y: auto;
|
||||||
|
padding: 0 15px;
|
||||||
|
padding-bottom: 50px;
|
||||||
|
}
|
||||||
|
.content main {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
}
|
||||||
|
.content p { line-height: 1.45em; }
|
||||||
|
.content ol { line-height: 1.45em; }
|
||||||
|
.content ul { line-height: 1.45em; }
|
||||||
|
.content a { text-decoration: none; }
|
||||||
|
.content a:hover { text-decoration: underline; }
|
||||||
|
.content img, .content video { max-width: 100%; }
|
||||||
|
.content .header:link,
|
||||||
|
.content .header:visited {
|
||||||
|
color: var(--fg);
|
||||||
|
}
|
||||||
|
.content .header:link,
|
||||||
|
.content .header:visited:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
table {
|
||||||
|
margin: 0 auto;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table td {
|
||||||
|
padding: 3px 20px;
|
||||||
|
border: 1px var(--table-border-color) solid;
|
||||||
|
}
|
||||||
|
table thead {
|
||||||
|
background: var(--table-header-bg);
|
||||||
|
}
|
||||||
|
table thead td {
|
||||||
|
font-weight: 700;
|
||||||
|
border: none;
|
||||||
|
}
|
||||||
|
table thead th {
|
||||||
|
padding: 3px 20px;
|
||||||
|
}
|
||||||
|
table thead tr {
|
||||||
|
border: 1px var(--table-header-bg) solid;
|
||||||
|
}
|
||||||
|
/* Alternate background colors for rows */
|
||||||
|
table tbody tr:nth-child(2n) {
|
||||||
|
background: var(--table-alternate-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
margin: 20px 0;
|
||||||
|
padding: 0 20px;
|
||||||
|
color: var(--fg);
|
||||||
|
background-color: var(--quote-bg);
|
||||||
|
border-top: .1em solid var(--quote-border);
|
||||||
|
border-bottom: .1em solid var(--quote-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
:not(.footnote-definition) + .footnote-definition,
|
||||||
|
.footnote-definition + :not(.footnote-definition) {
|
||||||
|
margin-top: 2em;
|
||||||
|
}
|
||||||
|
.footnote-definition {
|
||||||
|
font-size: 0.9em;
|
||||||
|
margin: 0.5em 0;
|
||||||
|
}
|
||||||
|
.footnote-definition p {
|
||||||
|
display: inline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tooltiptext {
|
||||||
|
position: absolute;
|
||||||
|
visibility: hidden;
|
||||||
|
color: #fff;
|
||||||
|
background-color: #333;
|
||||||
|
transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
|
||||||
|
left: -8px; /* Half of the width of the icon */
|
||||||
|
top: -35px;
|
||||||
|
font-size: 0.8em;
|
||||||
|
text-align: center;
|
||||||
|
border-radius: 6px;
|
||||||
|
padding: 5px 8px;
|
||||||
|
margin: 5px;
|
||||||
|
z-index: 1000;
|
||||||
|
}
|
||||||
|
.tooltipped .tooltiptext {
|
||||||
|
visibility: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.part-title {
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
margin: 5px 0px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
54
0.2.0/css/print.css
Normal file
54
0.2.0/css/print.css
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
|
||||||
|
#sidebar,
|
||||||
|
#menu-bar,
|
||||||
|
.nav-chapters,
|
||||||
|
.mobile-nav-chapters {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#page-wrapper.page-wrapper {
|
||||||
|
transform: none;
|
||||||
|
margin-left: 0px;
|
||||||
|
overflow-y: initial;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
max-width: none;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.page {
|
||||||
|
overflow-y: initial;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
background-color: #666666;
|
||||||
|
border-radius: 5px;
|
||||||
|
|
||||||
|
/* Force background to be printed in Chrome */
|
||||||
|
-webkit-print-color-adjust: exact;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre > .buttons {
|
||||||
|
z-index: 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
a, a:visited, a:active, a:hover {
|
||||||
|
color: #4183c4;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
page-break-inside: avoid;
|
||||||
|
page-break-after: avoid;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre, code {
|
||||||
|
page-break-inside: avoid;
|
||||||
|
white-space: pre-wrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fa {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
253
0.2.0/css/variables.css
Normal file
253
0.2.0/css/variables.css
Normal file
|
|
@ -0,0 +1,253 @@
|
||||||
|
|
||||||
|
/* Globals */
|
||||||
|
|
||||||
|
:root {
|
||||||
|
--sidebar-width: 300px;
|
||||||
|
--page-padding: 15px;
|
||||||
|
--content-max-width: 750px;
|
||||||
|
--menu-bar-height: 50px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Themes */
|
||||||
|
|
||||||
|
.ayu {
|
||||||
|
--bg: hsl(210, 25%, 8%);
|
||||||
|
--fg: #c5c5c5;
|
||||||
|
|
||||||
|
--sidebar-bg: #14191f;
|
||||||
|
--sidebar-fg: #c8c9db;
|
||||||
|
--sidebar-non-existant: #5c6773;
|
||||||
|
--sidebar-active: #ffb454;
|
||||||
|
--sidebar-spacer: #2d334f;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #737480;
|
||||||
|
--icons-hover: #b7b9cc;
|
||||||
|
|
||||||
|
--links: #0096cf;
|
||||||
|
|
||||||
|
--inline-code-color: #ffb454;
|
||||||
|
|
||||||
|
--theme-popup-bg: #14191f;
|
||||||
|
--theme-popup-border: #5c6773;
|
||||||
|
--theme-hover: #191f26;
|
||||||
|
|
||||||
|
--quote-bg: hsl(226, 15%, 17%);
|
||||||
|
--quote-border: hsl(226, 15%, 22%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(210, 25%, 13%);
|
||||||
|
--table-header-bg: hsl(210, 25%, 28%);
|
||||||
|
--table-alternate-bg: hsl(210, 25%, 11%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #848484;
|
||||||
|
--searchbar-bg: #424242;
|
||||||
|
--searchbar-fg: #fff;
|
||||||
|
--searchbar-shadow-color: #d4c89f;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #888;
|
||||||
|
--searchresults-li-bg: #252932;
|
||||||
|
--search-mark-bg: #e3b171;
|
||||||
|
}
|
||||||
|
|
||||||
|
.coal {
|
||||||
|
--bg: hsl(200, 7%, 8%);
|
||||||
|
--fg: #98a3ad;
|
||||||
|
|
||||||
|
--sidebar-bg: #292c2f;
|
||||||
|
--sidebar-fg: #a1adb8;
|
||||||
|
--sidebar-non-existant: #505254;
|
||||||
|
--sidebar-active: #3473ad;
|
||||||
|
--sidebar-spacer: #393939;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #43484d;
|
||||||
|
--icons-hover: #b3c0cc;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #c5c8c6;;
|
||||||
|
|
||||||
|
--theme-popup-bg: #141617;
|
||||||
|
--theme-popup-border: #43484d;
|
||||||
|
--theme-hover: #1f2124;
|
||||||
|
|
||||||
|
--quote-bg: hsl(234, 21%, 18%);
|
||||||
|
--quote-border: hsl(234, 21%, 23%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(200, 7%, 13%);
|
||||||
|
--table-header-bg: hsl(200, 7%, 28%);
|
||||||
|
--table-alternate-bg: hsl(200, 7%, 11%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #b7b7b7;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #98a3ad;
|
||||||
|
--searchresults-li-bg: #2b2b2f;
|
||||||
|
--search-mark-bg: #355c7d;
|
||||||
|
}
|
||||||
|
|
||||||
|
.light {
|
||||||
|
--bg: hsl(0, 0%, 100%);
|
||||||
|
--fg: hsl(0, 0%, 0%);
|
||||||
|
|
||||||
|
--sidebar-bg: #fafafa;
|
||||||
|
--sidebar-fg: hsl(0, 0%, 0%);
|
||||||
|
--sidebar-non-existant: #aaaaaa;
|
||||||
|
--sidebar-active: #1f1fff;
|
||||||
|
--sidebar-spacer: #f4f4f4;
|
||||||
|
|
||||||
|
--scrollbar: #8F8F8F;
|
||||||
|
|
||||||
|
--icons: #747474;
|
||||||
|
--icons-hover: #000000;
|
||||||
|
|
||||||
|
--links: #20609f;
|
||||||
|
|
||||||
|
--inline-code-color: #301900;
|
||||||
|
|
||||||
|
--theme-popup-bg: #fafafa;
|
||||||
|
--theme-popup-border: #cccccc;
|
||||||
|
--theme-hover: #e6e6e6;
|
||||||
|
|
||||||
|
--quote-bg: hsl(197, 37%, 96%);
|
||||||
|
--quote-border: hsl(197, 37%, 91%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(0, 0%, 95%);
|
||||||
|
--table-header-bg: hsl(0, 0%, 80%);
|
||||||
|
--table-alternate-bg: hsl(0, 0%, 97%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #fafafa;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #888;
|
||||||
|
--searchresults-li-bg: #e4f2fe;
|
||||||
|
--search-mark-bg: #a2cff5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navy {
|
||||||
|
--bg: hsl(226, 23%, 11%);
|
||||||
|
--fg: #bcbdd0;
|
||||||
|
|
||||||
|
--sidebar-bg: #282d3f;
|
||||||
|
--sidebar-fg: #c8c9db;
|
||||||
|
--sidebar-non-existant: #505274;
|
||||||
|
--sidebar-active: #2b79a2;
|
||||||
|
--sidebar-spacer: #2d334f;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #737480;
|
||||||
|
--icons-hover: #b7b9cc;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #c5c8c6;;
|
||||||
|
|
||||||
|
--theme-popup-bg: #161923;
|
||||||
|
--theme-popup-border: #737480;
|
||||||
|
--theme-hover: #282e40;
|
||||||
|
|
||||||
|
--quote-bg: hsl(226, 15%, 17%);
|
||||||
|
--quote-border: hsl(226, 15%, 22%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(226, 23%, 16%);
|
||||||
|
--table-header-bg: hsl(226, 23%, 31%);
|
||||||
|
--table-alternate-bg: hsl(226, 23%, 14%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #aeaec6;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #5f5f71;
|
||||||
|
--searchresults-border-color: #5c5c68;
|
||||||
|
--searchresults-li-bg: #242430;
|
||||||
|
--search-mark-bg: #a2cff5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rust {
|
||||||
|
--bg: hsl(60, 9%, 87%);
|
||||||
|
--fg: #262625;
|
||||||
|
|
||||||
|
--sidebar-bg: #3b2e2a;
|
||||||
|
--sidebar-fg: #c8c9db;
|
||||||
|
--sidebar-non-existant: #505254;
|
||||||
|
--sidebar-active: #e69f67;
|
||||||
|
--sidebar-spacer: #45373a;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #737480;
|
||||||
|
--icons-hover: #262625;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #6e6b5e;
|
||||||
|
|
||||||
|
--theme-popup-bg: #e1e1db;
|
||||||
|
--theme-popup-border: #b38f6b;
|
||||||
|
--theme-hover: #99908a;
|
||||||
|
|
||||||
|
--quote-bg: hsl(60, 5%, 75%);
|
||||||
|
--quote-border: hsl(60, 5%, 70%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(60, 9%, 82%);
|
||||||
|
--table-header-bg: #b3a497;
|
||||||
|
--table-alternate-bg: hsl(60, 9%, 84%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #fafafa;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #888;
|
||||||
|
--searchresults-li-bg: #dec2a2;
|
||||||
|
--search-mark-bg: #e69f67;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
.light.no-js {
|
||||||
|
--bg: hsl(200, 7%, 8%);
|
||||||
|
--fg: #98a3ad;
|
||||||
|
|
||||||
|
--sidebar-bg: #292c2f;
|
||||||
|
--sidebar-fg: #a1adb8;
|
||||||
|
--sidebar-non-existant: #505254;
|
||||||
|
--sidebar-active: #3473ad;
|
||||||
|
--sidebar-spacer: #393939;
|
||||||
|
|
||||||
|
--scrollbar: var(--sidebar-fg);
|
||||||
|
|
||||||
|
--icons: #43484d;
|
||||||
|
--icons-hover: #b3c0cc;
|
||||||
|
|
||||||
|
--links: #2b79a2;
|
||||||
|
|
||||||
|
--inline-code-color: #c5c8c6;;
|
||||||
|
|
||||||
|
--theme-popup-bg: #141617;
|
||||||
|
--theme-popup-border: #43484d;
|
||||||
|
--theme-hover: #1f2124;
|
||||||
|
|
||||||
|
--quote-bg: hsl(234, 21%, 18%);
|
||||||
|
--quote-border: hsl(234, 21%, 23%);
|
||||||
|
|
||||||
|
--table-border-color: hsl(200, 7%, 13%);
|
||||||
|
--table-header-bg: hsl(200, 7%, 28%);
|
||||||
|
--table-alternate-bg: hsl(200, 7%, 11%);
|
||||||
|
|
||||||
|
--searchbar-border-color: #aaa;
|
||||||
|
--searchbar-bg: #b7b7b7;
|
||||||
|
--searchbar-fg: #000;
|
||||||
|
--searchbar-shadow-color: #aaa;
|
||||||
|
--searchresults-header-fg: #666;
|
||||||
|
--searchresults-border-color: #98a3ad;
|
||||||
|
--searchresults-li-bg: #2b2b2f;
|
||||||
|
--search-mark-bg: #355c7d;
|
||||||
|
}
|
||||||
|
}
|
||||||
10
0.2.0/elasticlunr.min.js
vendored
Normal file
10
0.2.0/elasticlunr.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
BIN
0.2.0/favicon.png
Normal file
BIN
0.2.0/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.5 KiB |
22
0.2.0/favicon.svg
Normal file
22
0.2.0/favicon.svg
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 199.7 184.2">
|
||||||
|
<style>
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
svg { fill: white; }
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<path d="M189.5,36.8c0.2,2.8,0,5.1-0.6,6.8L153,162c-0.6,2.1-2,3.7-4.2,5c-2.2,1.2-4.4,1.9-6.7,1.9H31.4c-9.6,0-15.3-2.8-17.3-8.4
|
||||||
|
c-0.8-2.2-0.8-3.9,0.1-5.2c0.9-1.2,2.4-1.8,4.6-1.8H123c7.4,0,12.6-1.4,15.4-4.1s5.7-8.9,8.6-18.4l32.9-108.6
|
||||||
|
c1.8-5.9,1-11.1-2.2-15.6S169.9,0,164,0H72.7c-1,0-3.1,0.4-6.1,1.1l0.1-0.4C64.5,0.2,62.6,0,61,0.1s-3,0.5-4.3,1.4
|
||||||
|
c-1.3,0.9-2.4,1.8-3.2,2.8S52,6.5,51.2,8.1c-0.8,1.6-1.4,3-1.9,4.3s-1.1,2.7-1.8,4.2c-0.7,1.5-1.3,2.7-2,3.7c-0.5,0.6-1.2,1.5-2,2.5
|
||||||
|
s-1.6,2-2.2,2.8s-0.9,1.5-1.1,2.2c-0.2,0.7-0.1,1.8,0.2,3.2c0.3,1.4,0.4,2.4,0.4,3.1c-0.3,3-1.4,6.9-3.3,11.6
|
||||||
|
c-1.9,4.7-3.6,8.1-5.1,10.1c-0.3,0.4-1.2,1.3-2.6,2.7c-1.4,1.4-2.3,2.6-2.6,3.7c-0.3,0.4-0.3,1.5-0.1,3.4c0.3,1.8,0.4,3.1,0.3,3.8
|
||||||
|
c-0.3,2.7-1.3,6.3-3,10.8c-1.7,4.5-3.4,8.2-5,11c-0.2,0.5-0.9,1.4-2,2.8c-1.1,1.4-1.8,2.5-2,3.4c-0.2,0.6-0.1,1.8,0.1,3.4
|
||||||
|
c0.2,1.6,0.2,2.8-0.1,3.6c-0.6,3-1.8,6.7-3.6,11c-1.8,4.3-3.6,7.9-5.4,11c-0.5,0.8-1.1,1.7-2,2.8c-0.8,1.1-1.5,2-2,2.8
|
||||||
|
s-0.8,1.6-1,2.5c-0.1,0.5,0,1.3,0.4,2.3c0.3,1.1,0.4,1.9,0.4,2.6c-0.1,1.1-0.2,2.6-0.5,4.4c-0.2,1.8-0.4,2.9-0.4,3.2
|
||||||
|
c-1.8,4.8-1.7,9.9,0.2,15.2c2.2,6.2,6.2,11.5,11.9,15.8c5.7,4.3,11.7,6.4,17.8,6.4h110.7c5.2,0,10.1-1.7,14.7-5.2s7.7-7.8,9.2-12.9
|
||||||
|
l33-108.6c1.8-5.8,1-10.9-2.2-15.5C194.9,39.7,192.6,38,189.5,36.8z M59.6,122.8L73.8,80c0,0,7,0,10.8,0s28.8-1.7,25.4,17.5
|
||||||
|
c-3.4,19.2-18.8,25.2-36.8,25.4S59.6,122.8,59.6,122.8z M78.6,116.8c4.7-0.1,18.9-2.9,22.1-17.1S89.2,86.3,89.2,86.3l-8.9,0
|
||||||
|
l-10.2,30.5C70.2,116.9,74,116.9,78.6,116.8z M75.3,68.7L89,26.2h9.8l0.8,34l23.6-34h9.9l-13.6,42.5h-7.1l12.5-35.4l-24.5,35.4h-6.8
|
||||||
|
l-0.8-35L82,68.7H75.3z"/>
|
||||||
|
</svg>
|
||||||
|
<!-- Original image Copyright Dave Gandy — CC BY 4.0 License -->
|
||||||
|
After Width: | Height: | Size: 1.8 KiB |
202
0.2.0/fonts/OPEN-SANS-LICENSE.txt
Normal file
202
0.2.0/fonts/OPEN-SANS-LICENSE.txt
Normal file
|
|
@ -0,0 +1,202 @@
|
||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
93
0.2.0/fonts/SOURCE-CODE-PRO-LICENSE.txt
Normal file
93
0.2.0/fonts/SOURCE-CODE-PRO-LICENSE.txt
Normal file
|
|
@ -0,0 +1,93 @@
|
||||||
|
Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
|
||||||
|
|
||||||
|
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||||
|
This license is copied below, and is also available with a FAQ at:
|
||||||
|
http://scripts.sil.org/OFL
|
||||||
|
|
||||||
|
|
||||||
|
-----------------------------------------------------------
|
||||||
|
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||||
|
-----------------------------------------------------------
|
||||||
|
|
||||||
|
PREAMBLE
|
||||||
|
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||||
|
development of collaborative font projects, to support the font creation
|
||||||
|
efforts of academic and linguistic communities, and to provide a free and
|
||||||
|
open framework in which fonts may be shared and improved in partnership
|
||||||
|
with others.
|
||||||
|
|
||||||
|
The OFL allows the licensed fonts to be used, studied, modified and
|
||||||
|
redistributed freely as long as they are not sold by themselves. The
|
||||||
|
fonts, including any derivative works, can be bundled, embedded,
|
||||||
|
redistributed and/or sold with any software provided that any reserved
|
||||||
|
names are not used by derivative works. The fonts and derivatives,
|
||||||
|
however, cannot be released under any other type of license. The
|
||||||
|
requirement for fonts to remain under this license does not apply
|
||||||
|
to any document created using the fonts or their derivatives.
|
||||||
|
|
||||||
|
DEFINITIONS
|
||||||
|
"Font Software" refers to the set of files released by the Copyright
|
||||||
|
Holder(s) under this license and clearly marked as such. This may
|
||||||
|
include source files, build scripts and documentation.
|
||||||
|
|
||||||
|
"Reserved Font Name" refers to any names specified as such after the
|
||||||
|
copyright statement(s).
|
||||||
|
|
||||||
|
"Original Version" refers to the collection of Font Software components as
|
||||||
|
distributed by the Copyright Holder(s).
|
||||||
|
|
||||||
|
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||||
|
or substituting -- in part or in whole -- any of the components of the
|
||||||
|
Original Version, by changing formats or by porting the Font Software to a
|
||||||
|
new environment.
|
||||||
|
|
||||||
|
"Author" refers to any designer, engineer, programmer, technical
|
||||||
|
writer or other person who contributed to the Font Software.
|
||||||
|
|
||||||
|
PERMISSION & CONDITIONS
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
|
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||||
|
redistribute, and sell modified and unmodified copies of the Font
|
||||||
|
Software, subject to the following conditions:
|
||||||
|
|
||||||
|
1) Neither the Font Software nor any of its individual components,
|
||||||
|
in Original or Modified Versions, may be sold by itself.
|
||||||
|
|
||||||
|
2) Original or Modified Versions of the Font Software may be bundled,
|
||||||
|
redistributed and/or sold with any software, provided that each copy
|
||||||
|
contains the above copyright notice and this license. These can be
|
||||||
|
included either as stand-alone text files, human-readable headers or
|
||||||
|
in the appropriate machine-readable metadata fields within text or
|
||||||
|
binary files as long as those fields can be easily viewed by the user.
|
||||||
|
|
||||||
|
3) No Modified Version of the Font Software may use the Reserved Font
|
||||||
|
Name(s) unless explicit written permission is granted by the corresponding
|
||||||
|
Copyright Holder. This restriction only applies to the primary font name as
|
||||||
|
presented to the users.
|
||||||
|
|
||||||
|
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||||
|
Software shall not be used to promote, endorse or advertise any
|
||||||
|
Modified Version, except to acknowledge the contribution(s) of the
|
||||||
|
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||||
|
permission.
|
||||||
|
|
||||||
|
5) The Font Software, modified or unmodified, in part or in whole,
|
||||||
|
must be distributed entirely under this license, and must not be
|
||||||
|
distributed under any other license. The requirement for fonts to
|
||||||
|
remain under this license does not apply to any document created
|
||||||
|
using the Font Software.
|
||||||
|
|
||||||
|
TERMINATION
|
||||||
|
This license becomes null and void if any of the above conditions are
|
||||||
|
not met.
|
||||||
|
|
||||||
|
DISCLAIMER
|
||||||
|
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||||
|
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||||
|
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||||
|
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||||
|
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||||
100
0.2.0/fonts/fonts.css
Normal file
100
0.2.0/fonts/fonts.css
Normal file
|
|
@ -0,0 +1,100 @@
|
||||||
|
/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
|
||||||
|
/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
|
||||||
|
|
||||||
|
/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 300;
|
||||||
|
src: local('Open Sans Light'), local('OpenSans-Light'),
|
||||||
|
url('open-sans-v17-all-charsets-300.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 300;
|
||||||
|
src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
src: local('Open Sans Regular'), local('OpenSans-Regular'),
|
||||||
|
url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 400;
|
||||||
|
src: local('Open Sans Italic'), local('OpenSans-Italic'),
|
||||||
|
url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 600;
|
||||||
|
src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
|
||||||
|
url('open-sans-v17-all-charsets-600.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 600;
|
||||||
|
src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 700;
|
||||||
|
src: local('Open Sans Bold'), local('OpenSans-Bold'),
|
||||||
|
url('open-sans-v17-all-charsets-700.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 700;
|
||||||
|
src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 800;
|
||||||
|
src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
|
||||||
|
url('open-sans-v17-all-charsets-800.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Open Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 800;
|
||||||
|
src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
|
||||||
|
url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
|
||||||
|
}
|
||||||
|
|
||||||
|
/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Source Code Pro';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 500;
|
||||||
|
src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
|
||||||
|
}
|
||||||
BIN
0.2.0/fonts/open-sans-v17-all-charsets-300.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-300.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-300italic.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-300italic.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-600.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-600.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-600italic.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-600italic.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-700.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-700.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-700italic.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-700italic.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-800.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-800.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-800italic.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-800italic.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-italic.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-italic.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/open-sans-v17-all-charsets-regular.woff2
Normal file
BIN
0.2.0/fonts/open-sans-v17-all-charsets-regular.woff2
Normal file
Binary file not shown.
BIN
0.2.0/fonts/source-code-pro-v11-all-charsets-500.woff2
Normal file
BIN
0.2.0/fonts/source-code-pro-v11-all-charsets-500.woff2
Normal file
Binary file not shown.
83
0.2.0/highlight.css
Normal file
83
0.2.0/highlight.css
Normal file
|
|
@ -0,0 +1,83 @@
|
||||||
|
/*
|
||||||
|
* An increased contrast highlighting scheme loosely based on the
|
||||||
|
* "Base16 Atelier Dune Light" theme by Bram de Haan
|
||||||
|
* (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
|
||||||
|
* Original Base16 color scheme by Chris Kempson
|
||||||
|
* (https://github.com/chriskempson/base16)
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* Comment */
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-quote {
|
||||||
|
color: #575757;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Red */
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-tag,
|
||||||
|
.hljs-name,
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-link,
|
||||||
|
.hljs-name,
|
||||||
|
.hljs-selector-id,
|
||||||
|
.hljs-selector-class {
|
||||||
|
color: #d70025;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Orange */
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-meta,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-builtin-name,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-type,
|
||||||
|
.hljs-params {
|
||||||
|
color: #b21e00;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Green */
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-symbol,
|
||||||
|
.hljs-bullet {
|
||||||
|
color: #008200;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Blue */
|
||||||
|
.hljs-title,
|
||||||
|
.hljs-section {
|
||||||
|
color: #0030f2;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Purple */
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-selector-tag {
|
||||||
|
color: #9d00ec;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
background: #f6f7f6;
|
||||||
|
color: #000;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-emphasis {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
color: #22863a;
|
||||||
|
background-color: #f0fff4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
color: #b31d28;
|
||||||
|
background-color: #ffeef0;
|
||||||
|
}
|
||||||
6
0.2.0/highlight.js
Normal file
6
0.2.0/highlight.js
Normal file
File diff suppressed because one or more lines are too long
547
0.2.0/index.html
Normal file
547
0.2.0/index.html
Normal file
|
|
@ -0,0 +1,547 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>Rules ForeignCc - Rules ForeignCc</title>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html" class="active"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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="rules-foreign-cc"><a class="header" href="#rules-foreign-cc">Rules Foreign CC</a></h1>
|
||||||
|
<ul>
|
||||||
|
<li><a href="#boost_build">boost_build</a></li>
|
||||||
|
<li><a href="#cmake">cmake</a></li>
|
||||||
|
<li><a href="#cmake_tool">cmake_tool</a></li>
|
||||||
|
<li><a href="#configure_make">configure_make</a></li>
|
||||||
|
<li><a href="#ForeignCcArtifact">ForeignCcArtifact</a></li>
|
||||||
|
<li><a href="#ForeignCcDeps">ForeignCcDeps</a></li>
|
||||||
|
<li><a href="#make">make</a></li>
|
||||||
|
<li><a href="#make_tool">make_tool</a></li>
|
||||||
|
<li><a href="#native_tool_toolchain">native_tool_toolchain</a></li>
|
||||||
|
<li><a href="#ninja">ninja</a></li>
|
||||||
|
<li><a href="#ninja_tool">ninja_tool</a></li>
|
||||||
|
<li><a href="#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></li>
|
||||||
|
<li><a href="#ToolInfo">ToolInfo</a></li>
|
||||||
|
</ul>
|
||||||
|
<p><a id="#boost_build"></a></p>
|
||||||
|
<h2 id="boost_build"><a class="header" href="#boost_build">boost_build</a></h2>
|
||||||
|
<pre>
|
||||||
|
boost_build(<a href="#boost_build-name">name</a>, <a href="#boost_build-additional_inputs">additional_inputs</a>, <a href="#boost_build-additional_tools">additional_tools</a>, <a href="#boost_build-alwayslink">alwayslink</a>, <a href="#boost_build-binaries">binaries</a>, <a href="#boost_build-bootstrap_options">bootstrap_options</a>,
|
||||||
|
<a href="#boost_build-data">data</a>, <a href="#boost_build-defines">defines</a>, <a href="#boost_build-deps">deps</a>, <a href="#boost_build-env">env</a>, <a href="#boost_build-headers_only">headers_only</a>, <a href="#boost_build-interface_libraries">interface_libraries</a>, <a href="#boost_build-lib_name">lib_name</a>, <a href="#boost_build-lib_source">lib_source</a>,
|
||||||
|
<a href="#boost_build-linkopts">linkopts</a>, <a href="#boost_build-out_bin_dir">out_bin_dir</a>, <a href="#boost_build-out_binaries">out_binaries</a>, <a href="#boost_build-out_headers_only">out_headers_only</a>, <a href="#boost_build-out_include_dir">out_include_dir</a>,
|
||||||
|
<a href="#boost_build-out_interface_libs">out_interface_libs</a>, <a href="#boost_build-out_lib_dir">out_lib_dir</a>, <a href="#boost_build-out_shared_libs">out_shared_libs</a>, <a href="#boost_build-out_static_libs">out_static_libs</a>, <a href="#boost_build-postfix_script">postfix_script</a>,
|
||||||
|
<a href="#boost_build-shared_libraries">shared_libraries</a>, <a href="#boost_build-static_libraries">static_libraries</a>, <a href="#boost_build-tools_deps">tools_deps</a>, <a href="#boost_build-user_options">user_options</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Boost. Invokes bootstrap.sh and then b2 install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="boost_build-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-bootstrap_options"></a>bootstrap_options</td><td align="left">any additional flags to pass to bootstrap.sh</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-user_options"></a>user_options</td><td align="left">any additional flags to pass to b2</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake"></a></p>
|
||||||
|
<h2 id="cmake"><a class="header" href="#cmake">cmake</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake(<a href="#cmake-name">name</a>, <a href="#cmake-additional_inputs">additional_inputs</a>, <a href="#cmake-additional_tools">additional_tools</a>, <a href="#cmake-alwayslink">alwayslink</a>, <a href="#cmake-binaries">binaries</a>, <a href="#cmake-build_args">build_args</a>, <a href="#cmake-cache_entries">cache_entries</a>,
|
||||||
|
<a href="#cmake-cmake_options">cmake_options</a>, <a href="#cmake-data">data</a>, <a href="#cmake-defines">defines</a>, <a href="#cmake-deps">deps</a>, <a href="#cmake-env">env</a>, <a href="#cmake-env_vars">env_vars</a>, <a href="#cmake-generate_args">generate_args</a>, <a href="#cmake-generate_crosstool_file">generate_crosstool_file</a>,
|
||||||
|
<a href="#cmake-headers_only">headers_only</a>, <a href="#cmake-install">install</a>, <a href="#cmake-install_args">install_args</a>, <a href="#cmake-install_prefix">install_prefix</a>, <a href="#cmake-interface_libraries">interface_libraries</a>, <a href="#cmake-lib_name">lib_name</a>, <a href="#cmake-lib_source">lib_source</a>,
|
||||||
|
<a href="#cmake-linkopts">linkopts</a>, <a href="#cmake-make_commands">make_commands</a>, <a href="#cmake-out_bin_dir">out_bin_dir</a>, <a href="#cmake-out_binaries">out_binaries</a>, <a href="#cmake-out_headers_only">out_headers_only</a>, <a href="#cmake-out_include_dir">out_include_dir</a>,
|
||||||
|
<a href="#cmake-out_interface_libs">out_interface_libs</a>, <a href="#cmake-out_lib_dir">out_lib_dir</a>, <a href="#cmake-out_shared_libs">out_shared_libs</a>, <a href="#cmake-out_static_libs">out_static_libs</a>, <a href="#cmake-postfix_script">postfix_script</a>,
|
||||||
|
<a href="#cmake-shared_libraries">shared_libraries</a>, <a href="#cmake-static_libraries">static_libraries</a>, <a href="#cmake-targets">targets</a>, <a href="#cmake-tools_deps">tools_deps</a>, <a href="#cmake-working_directory">working_directory</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external library with CMake.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-build_args"></a>build_args</td><td align="left">Arguments for the CMake build command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-cache_entries"></a>cache_entries</td><td align="left">CMake cache entries to initialize (they will be passed with <code>-Dkey=value</code>) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-cmake_options"></a>cmake_options</td><td align="left"><strong>deprecated</strong>: Use <code>generate_args</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-env_vars"></a>env_vars</td><td align="left">CMake environment variable values to join with toolchain-defined. For example, additional <code>CXXFLAGS</code>.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-generate_args"></a>generate_args</td><td align="left">Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: <code>["-G Ninja", "--debug-output", "-DFOO=bar"]</code>. Note that unless a generator (<code>-G</code>) argument is provided, the default generators are <a href="https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html">Unix Makefiles</a> for Linux and MacOS and <a href="https://cmake.org/cmake/help/latest/generator/Ninja.html">Ninja</a> for Windows.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-generate_crosstool_file"></a>generate_crosstool_file</td><td align="left">When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as <code>-Dkey=value</code> and environment variables). If <code>CMAKE_TOOLCHAIN_FILE</code> cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify <code>CMAKE_SYSTEM_NAME</code> in the cache_entries</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install"></a>install</td><td align="left">If True, the <code>cmake --install</code> comand will be performed after a build</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install_args"></a>install_args</td><td align="left">Arguments for the CMake install command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install_prefix"></a>install_prefix</td><td align="left">Relative install prefix to be passed to CMake in <code>-DCMAKE_INSTALL_PREFIX</code></td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-make_commands"></a>make_commands</td><td align="left"><strong>deprecated</strong>: Optional hard coded commands to replace the <code>cmake --build</code> commands. It's recommended to leave this empty and use the <code>targets</code> + <code>build_args</code> attributes.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-working_directory"></a>working_directory</td><td align="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake_tool"></a></p>
|
||||||
|
<h2 id="cmake_tool"><a class="header" href="#cmake_tool">cmake_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake_tool(<a href="#cmake_tool-name">name</a>, <a href="#cmake_tool-srcs">srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building CMake. Invokes bootstrap script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#configure_make"></a></p>
|
||||||
|
<h2 id="configure_make"><a class="header" href="#configure_make">configure_make</a></h2>
|
||||||
|
<pre>
|
||||||
|
configure_make(<a href="#configure_make-name">name</a>, <a href="#configure_make-additional_inputs">additional_inputs</a>, <a href="#configure_make-additional_tools">additional_tools</a>, <a href="#configure_make-alwayslink">alwayslink</a>, <a href="#configure_make-args">args</a>, <a href="#configure_make-autoconf">autoconf</a>,
|
||||||
|
<a href="#configure_make-autoconf_env_vars">autoconf_env_vars</a>, <a href="#configure_make-autoconf_options">autoconf_options</a>, <a href="#configure_make-autogen">autogen</a>, <a href="#configure_make-autogen_command">autogen_command</a>, <a href="#configure_make-autogen_env_vars">autogen_env_vars</a>,
|
||||||
|
<a href="#configure_make-autogen_options">autogen_options</a>, <a href="#configure_make-autoreconf">autoreconf</a>, <a href="#configure_make-autoreconf_env_vars">autoreconf_env_vars</a>, <a href="#configure_make-autoreconf_options">autoreconf_options</a>, <a href="#configure_make-binaries">binaries</a>,
|
||||||
|
<a href="#configure_make-configure_command">configure_command</a>, <a href="#configure_make-configure_env_vars">configure_env_vars</a>, <a href="#configure_make-configure_in_place">configure_in_place</a>, <a href="#configure_make-configure_options">configure_options</a>, <a href="#configure_make-data">data</a>,
|
||||||
|
<a href="#configure_make-defines">defines</a>, <a href="#configure_make-deps">deps</a>, <a href="#configure_make-env">env</a>, <a href="#configure_make-headers_only">headers_only</a>, <a href="#configure_make-install_prefix">install_prefix</a>, <a href="#configure_make-interface_libraries">interface_libraries</a>, <a href="#configure_make-lib_name">lib_name</a>,
|
||||||
|
<a href="#configure_make-lib_source">lib_source</a>, <a href="#configure_make-linkopts">linkopts</a>, <a href="#configure_make-make_commands">make_commands</a>, <a href="#configure_make-out_bin_dir">out_bin_dir</a>, <a href="#configure_make-out_binaries">out_binaries</a>, <a href="#configure_make-out_headers_only">out_headers_only</a>,
|
||||||
|
<a href="#configure_make-out_include_dir">out_include_dir</a>, <a href="#configure_make-out_interface_libs">out_interface_libs</a>, <a href="#configure_make-out_lib_dir">out_lib_dir</a>, <a href="#configure_make-out_shared_libs">out_shared_libs</a>, <a href="#configure_make-out_static_libs">out_static_libs</a>,
|
||||||
|
<a href="#configure_make-postfix_script">postfix_script</a>, <a href="#configure_make-shared_libraries">shared_libraries</a>, <a href="#configure_make-static_libraries">static_libraries</a>, <a href="#configure_make-targets">targets</a>, <a href="#configure_make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="configure_make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf"></a>autoconf</td><td align="left">Set to True if 'autoconf' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_env_vars"></a>autoconf_env_vars</td><td align="left">Environment variables to be set for 'autoconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_options"></a>autoconf_options</td><td align="left">Any options to be put in the 'autoconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen"></a>autogen</td><td align="left">Set to True if 'autogen.sh' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_command"></a>autogen_command</td><td align="left">The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.</td><td align="left">String</td><td align="left">optional</td><td align="left">"autogen.sh"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_env_vars"></a>autogen_env_vars</td><td align="left">Environment variables to be set for 'autogen' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_options"></a>autogen_options</td><td align="left">Any options to be put in the 'autogen.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf"></a>autoreconf</td><td align="left">Set to True if 'autoreconf' should be invoked before 'configure.', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_env_vars"></a>autoreconf_env_vars</td><td align="left">Environment variables to be set for 'autoreconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_options"></a>autoreconf_options</td><td align="left">Any options to be put in the 'autoreconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_command"></a>configure_command</td><td align="left">The name of the configuration script file, default: configure. The file must be in the root of the source directory.</td><td align="left">String</td><td align="left">optional</td><td align="left">"configure"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_env_vars"></a>configure_env_vars</td><td align="left">Environment variables to be set for the 'configure' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_in_place"></a>configure_in_place</td><td align="left">Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_options"></a>configure_options</td><td align="left">Any options to be put on the 'configure' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make"></a></p>
|
||||||
|
<h2 id="make"><a class="header" href="#make">make</a></h2>
|
||||||
|
<pre>
|
||||||
|
make(<a href="#make-name">name</a>, <a href="#make-additional_inputs">additional_inputs</a>, <a href="#make-additional_tools">additional_tools</a>, <a href="#make-alwayslink">alwayslink</a>, <a href="#make-args">args</a>, <a href="#make-binaries">binaries</a>, <a href="#make-data">data</a>, <a href="#make-defines">defines</a>, <a href="#make-deps">deps</a>,
|
||||||
|
<a href="#make-env">env</a>, <a href="#make-headers_only">headers_only</a>, <a href="#make-interface_libraries">interface_libraries</a>, <a href="#make-keep_going">keep_going</a>, <a href="#make-lib_name">lib_name</a>, <a href="#make-lib_source">lib_source</a>, <a href="#make-linkopts">linkopts</a>,
|
||||||
|
<a href="#make-make_commands">make_commands</a>, <a href="#make-make_env_vars">make_env_vars</a>, <a href="#make-out_bin_dir">out_bin_dir</a>, <a href="#make-out_binaries">out_binaries</a>, <a href="#make-out_headers_only">out_headers_only</a>, <a href="#make-out_include_dir">out_include_dir</a>,
|
||||||
|
<a href="#make-out_interface_libs">out_interface_libs</a>, <a href="#make-out_lib_dir">out_lib_dir</a>, <a href="#make-out_shared_libs">out_shared_libs</a>, <a href="#make-out_static_libs">out_static_libs</a>, <a href="#make-postfix_script">postfix_script</a>, <a href="#make-prefix">prefix</a>,
|
||||||
|
<a href="#make-shared_libraries">shared_libraries</a>, <a href="#make-static_libraries">static_libraries</a>, <a href="#make-targets">targets</a>, <a href="#make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with prefix="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-keep_going"></a>keep_going</td><td align="left"><strong>deprecated</strong>: To maintain this behavior, pass <code>-k</code> to the <code>args</code> attribute when not using the <code>make_commands</code> attribute.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_commands"></a>make_commands</td><td align="left"><strong>deprecated</strong>: A list of hard coded bash commands for building source code. It's recommended to leave this empty and use the <code>targets</code> + <code>args</code> attributes.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_env_vars"></a>make_env_vars</td><td align="left"><strong>deprecated</strong>: Use the <code>env</code> attribute</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-prefix"></a>prefix</td><td align="left"><strong>deprecated</strong>: To maintain this behavior, pass <code>PREFIX=<value></code> to the <code>args</code> attribute</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make_tool"></a></p>
|
||||||
|
<h2 id="make_tool"><a class="header" href="#make_tool">make_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
make_tool(<a href="#make_tool-name">name</a>, <a href="#make_tool-srcs">srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Make. Invokes configure script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#native_tool_toolchain"></a></p>
|
||||||
|
<h2 id="native_tool_toolchain"><a class="header" href="#native_tool_toolchain">native_tool_toolchain</a></h2>
|
||||||
|
<pre>
|
||||||
|
native_tool_toolchain(<a href="#native_tool_toolchain-name">name</a>, <a href="#native_tool_toolchain-path">path</a>, <a href="#native_tool_toolchain-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types <code>@rules_foreign_cc//toolchains:cmake_toolchain</code> and <code>@rules_foreign_cc//toolchains:ninja_toolchain</code>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">optional</td><td align="left">None</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja"></a></p>
|
||||||
|
<h2 id="ninja"><a class="header" href="#ninja">ninja</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja(<a href="#ninja-name">name</a>, <a href="#ninja-additional_inputs">additional_inputs</a>, <a href="#ninja-additional_tools">additional_tools</a>, <a href="#ninja-alwayslink">alwayslink</a>, <a href="#ninja-args">args</a>, <a href="#ninja-binaries">binaries</a>, <a href="#ninja-data">data</a>, <a href="#ninja-defines">defines</a>, <a href="#ninja-deps">deps</a>,
|
||||||
|
<a href="#ninja-directory">directory</a>, <a href="#ninja-env">env</a>, <a href="#ninja-headers_only">headers_only</a>, <a href="#ninja-interface_libraries">interface_libraries</a>, <a href="#ninja-lib_name">lib_name</a>, <a href="#ninja-lib_source">lib_source</a>, <a href="#ninja-linkopts">linkopts</a>, <a href="#ninja-out_bin_dir">out_bin_dir</a>,
|
||||||
|
<a href="#ninja-out_binaries">out_binaries</a>, <a href="#ninja-out_headers_only">out_headers_only</a>, <a href="#ninja-out_include_dir">out_include_dir</a>, <a href="#ninja-out_interface_libs">out_interface_libs</a>, <a href="#ninja-out_lib_dir">out_lib_dir</a>,
|
||||||
|
<a href="#ninja-out_shared_libs">out_shared_libs</a>, <a href="#ninja-out_static_libs">out_static_libs</a>, <a href="#ninja-postfix_script">postfix_script</a>, <a href="#ninja-shared_libraries">shared_libraries</a>, <a href="#ninja-static_libraries">static_libraries</a>, <a href="#ninja-targets">targets</a>,
|
||||||
|
<a href="#ninja-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with <a href="https://ninja-build.org/">Ninja</a>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>ninja</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-directory"></a>directory</td><td align="left">A directory to pass as the <code>-C</code> argument. The rule will always use the root directory of the <code>lib_sources</code> attribute if this attribute is not set</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja_tool"></a></p>
|
||||||
|
<h2 id="ninja_tool"><a class="header" href="#ninja_tool">ninja_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja_tool(<a href="#ninja_tool-name">name</a>, <a href="#ninja_tool-srcs">srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Ninja. Invokes configure script.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcArtifact"></a></p>
|
||||||
|
<h2 id="foreignccartifact"><a class="header" href="#foreignccartifact">ForeignCcArtifact</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcArtifact(<a href="#ForeignCcArtifact-bin_dir_name">bin_dir_name</a>, <a href="#ForeignCcArtifact-gen_dir">gen_dir</a>, <a href="#ForeignCcArtifact-include_dir_name">include_dir_name</a>, <a href="#ForeignCcArtifact-lib_dir_name">lib_dir_name</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Groups information about the external library install directory,
|
||||||
|
and relative bin, include and lib directories.</p>
|
||||||
|
<p>Serves to pass transitive information about externally built artifacts up the dependency chain.</p>
|
||||||
|
<p>Can not be used as a top-level provider.
|
||||||
|
Instances of ForeignCcArtifact are incapsulated in a depset ForeignCcDeps#artifacts.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-bin_dir_name"></a>bin_dir_name</td><td align="left">Bin directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-gen_dir"></a>gen_dir</td><td align="left">Install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-include_dir_name"></a>include_dir_name</td><td align="left">Include directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-lib_dir_name"></a>lib_dir_name</td><td align="left">Lib directory, relative to install directory</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcDeps"></a></p>
|
||||||
|
<h2 id="foreignccdeps"><a class="header" href="#foreignccdeps">ForeignCcDeps</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcDeps(<a href="#ForeignCcDeps-artifacts">artifacts</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Provider to pass transitive information about external libraries.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcDeps-artifacts"></a>artifacts</td><td align="left">Depset of ForeignCcArtifact</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ToolInfo"></a></p>
|
||||||
|
<h2 id="toolinfo"><a class="header" href="#toolinfo">ToolInfo</a></h2>
|
||||||
|
<pre>
|
||||||
|
ToolInfo(<a href="#ToolInfo-path">path</a>, <a href="#ToolInfo-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Information about the native tool</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td></tr>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#rules_foreign_cc_dependencies"></a></p>
|
||||||
|
<h2 id="rules_foreign_cc_dependencies"><a class="header" href="#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></h2>
|
||||||
|
<pre>
|
||||||
|
rules_foreign_cc_dependencies(<a href="#rules_foreign_cc_dependencies-native_tools_toolchains">native_tools_toolchains</a>, <a href="#rules_foreign_cc_dependencies-register_default_tools">register_default_tools</a>, <a href="#rules_foreign_cc_dependencies-cmake_version">cmake_version</a>,
|
||||||
|
<a href="#rules_foreign_cc_dependencies-make_version">make_version</a>, <a href="#rules_foreign_cc_dependencies-ninja_version">ninja_version</a>, <a href="#rules_foreign_cc_dependencies-register_preinstalled_tools">register_preinstalled_tools</a>,
|
||||||
|
<a href="#rules_foreign_cc_dependencies-register_built_tools">register_built_tools</a>, <a href="#rules_foreign_cc_dependencies-additional_shell_toolchain_mappings">additional_shell_toolchain_mappings</a>,
|
||||||
|
<a href="#rules_foreign_cc_dependencies-additional_shell_toolchain_package">additional_shell_toolchain_package</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Call this function from the WORKSPACE file to initialize rules_foreign_cc dependencies and let neccesary code generation happen (Code generation is needed to support different variants of the C++ Starlark API.).</p>
|
||||||
|
<p><strong>PARAMETERS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-native_tools_toolchains"></a>native_tools_toolchains</td><td align="left">pass the toolchains for toolchain types '@rules_foreign_cc//toolchains:cmake_toolchain' and '@rules_foreign_cc//toolchains:ninja_toolchain' with the needed platform constraints. If you do not pass anything, registered default toolchains will be selected (see below).</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_default_tools"></a>register_default_tools</td><td align="left">If True, the cmake and ninja toolchains, calling corresponding preinstalled binaries by name (cmake, ninja) will be registered after 'native_tools_toolchains' without any platform constraints. The default is True.</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-cmake_version"></a>cmake_version</td><td align="left">The target version of the cmake toolchain if <code>register_default_tools</code> or <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"3.19.6"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-make_version"></a>make_version</td><td align="left">The target version of the default make toolchain if <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"4.3"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-ninja_version"></a>ninja_version</td><td align="left">The target version of the ninja toolchain if <code>register_default_tools</code> or <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"1.10.2"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_preinstalled_tools"></a>register_preinstalled_tools</td><td align="left">If true, toolchains will be registered for the native built tools installed on the exec host</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_built_tools"></a>register_built_tools</td><td align="left">If true, toolchains that build the tools from source are registered</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_mappings"></a>additional_shell_toolchain_mappings</td><td align="left">Mappings of the shell toolchain functions to execution and target platforms constraints. Similar to what defined in @rules_foreign_cc//foreign_cc/private/shell_toolchain/toolchains:toolchain_mappings.bzl in the TOOLCHAIN_MAPPINGS list. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_package"></a>additional_shell_toolchain_package</td><td align="left">A package under which additional toolchains, referencing the generated data for the passed additonal_shell_toolchain_mappings, will be defined. This value is needed since register_toolchains() is called for these toolchains. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>None</code></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
|
||||||
|
|
||||||
|
<div style="clear: both"></div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
7
0.2.0/mark.min.js
vendored
Normal file
7
0.2.0/mark.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
553
0.2.0/print.html
Normal file
553
0.2.0/print.html
Normal file
|
|
@ -0,0 +1,553 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>Rules ForeignCc</title>
|
||||||
|
<meta name="robots" content="noindex" />
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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="rules-foreign-cc"><a class="header" href="#rules-foreign-cc">Rules Foreign CC</a></h1>
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#boost_build">boost_build</a></li>
|
||||||
|
<li><a href="index.html#cmake">cmake</a></li>
|
||||||
|
<li><a href="index.html#cmake_tool">cmake_tool</a></li>
|
||||||
|
<li><a href="index.html#configure_make">configure_make</a></li>
|
||||||
|
<li><a href="index.html#ForeignCcArtifact">ForeignCcArtifact</a></li>
|
||||||
|
<li><a href="index.html#ForeignCcDeps">ForeignCcDeps</a></li>
|
||||||
|
<li><a href="index.html#make">make</a></li>
|
||||||
|
<li><a href="index.html#make_tool">make_tool</a></li>
|
||||||
|
<li><a href="index.html#native_tool_toolchain">native_tool_toolchain</a></li>
|
||||||
|
<li><a href="index.html#ninja">ninja</a></li>
|
||||||
|
<li><a href="index.html#ninja_tool">ninja_tool</a></li>
|
||||||
|
<li><a href="index.html#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></li>
|
||||||
|
<li><a href="index.html#ToolInfo">ToolInfo</a></li>
|
||||||
|
</ul>
|
||||||
|
<p><a id="#boost_build"></a></p>
|
||||||
|
<h2 id="boost_build"><a class="header" href="#boost_build">boost_build</a></h2>
|
||||||
|
<pre>
|
||||||
|
boost_build(<a href="index.html#boost_build-name">name</a>, <a href="index.html#boost_build-additional_inputs">additional_inputs</a>, <a href="index.html#boost_build-additional_tools">additional_tools</a>, <a href="index.html#boost_build-alwayslink">alwayslink</a>, <a href="index.html#boost_build-binaries">binaries</a>, <a href="index.html#boost_build-bootstrap_options">bootstrap_options</a>,
|
||||||
|
<a href="index.html#boost_build-data">data</a>, <a href="index.html#boost_build-defines">defines</a>, <a href="index.html#boost_build-deps">deps</a>, <a href="index.html#boost_build-env">env</a>, <a href="index.html#boost_build-headers_only">headers_only</a>, <a href="index.html#boost_build-interface_libraries">interface_libraries</a>, <a href="index.html#boost_build-lib_name">lib_name</a>, <a href="index.html#boost_build-lib_source">lib_source</a>,
|
||||||
|
<a href="index.html#boost_build-linkopts">linkopts</a>, <a href="index.html#boost_build-out_bin_dir">out_bin_dir</a>, <a href="index.html#boost_build-out_binaries">out_binaries</a>, <a href="index.html#boost_build-out_headers_only">out_headers_only</a>, <a href="index.html#boost_build-out_include_dir">out_include_dir</a>,
|
||||||
|
<a href="index.html#boost_build-out_interface_libs">out_interface_libs</a>, <a href="index.html#boost_build-out_lib_dir">out_lib_dir</a>, <a href="index.html#boost_build-out_shared_libs">out_shared_libs</a>, <a href="index.html#boost_build-out_static_libs">out_static_libs</a>, <a href="index.html#boost_build-postfix_script">postfix_script</a>,
|
||||||
|
<a href="index.html#boost_build-shared_libraries">shared_libraries</a>, <a href="index.html#boost_build-static_libraries">static_libraries</a>, <a href="index.html#boost_build-tools_deps">tools_deps</a>, <a href="index.html#boost_build-user_options">user_options</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Boost. Invokes bootstrap.sh and then b2 install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="boost_build-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-bootstrap_options"></a>bootstrap_options</td><td align="left">any additional flags to pass to bootstrap.sh</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="boost_build-user_options"></a>user_options</td><td align="left">any additional flags to pass to b2</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake"></a></p>
|
||||||
|
<h2 id="cmake"><a class="header" href="#cmake">cmake</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake(<a href="index.html#cmake-name">name</a>, <a href="index.html#cmake-additional_inputs">additional_inputs</a>, <a href="index.html#cmake-additional_tools">additional_tools</a>, <a href="index.html#cmake-alwayslink">alwayslink</a>, <a href="index.html#cmake-binaries">binaries</a>, <a href="index.html#cmake-build_args">build_args</a>, <a href="index.html#cmake-cache_entries">cache_entries</a>,
|
||||||
|
<a href="index.html#cmake-cmake_options">cmake_options</a>, <a href="index.html#cmake-data">data</a>, <a href="index.html#cmake-defines">defines</a>, <a href="index.html#cmake-deps">deps</a>, <a href="index.html#cmake-env">env</a>, <a href="index.html#cmake-env_vars">env_vars</a>, <a href="index.html#cmake-generate_args">generate_args</a>, <a href="index.html#cmake-generate_crosstool_file">generate_crosstool_file</a>,
|
||||||
|
<a href="index.html#cmake-headers_only">headers_only</a>, <a href="index.html#cmake-install">install</a>, <a href="index.html#cmake-install_args">install_args</a>, <a href="index.html#cmake-install_prefix">install_prefix</a>, <a href="index.html#cmake-interface_libraries">interface_libraries</a>, <a href="index.html#cmake-lib_name">lib_name</a>, <a href="index.html#cmake-lib_source">lib_source</a>,
|
||||||
|
<a href="index.html#cmake-linkopts">linkopts</a>, <a href="index.html#cmake-make_commands">make_commands</a>, <a href="index.html#cmake-out_bin_dir">out_bin_dir</a>, <a href="index.html#cmake-out_binaries">out_binaries</a>, <a href="index.html#cmake-out_headers_only">out_headers_only</a>, <a href="index.html#cmake-out_include_dir">out_include_dir</a>,
|
||||||
|
<a href="index.html#cmake-out_interface_libs">out_interface_libs</a>, <a href="index.html#cmake-out_lib_dir">out_lib_dir</a>, <a href="index.html#cmake-out_shared_libs">out_shared_libs</a>, <a href="index.html#cmake-out_static_libs">out_static_libs</a>, <a href="index.html#cmake-postfix_script">postfix_script</a>,
|
||||||
|
<a href="index.html#cmake-shared_libraries">shared_libraries</a>, <a href="index.html#cmake-static_libraries">static_libraries</a>, <a href="index.html#cmake-targets">targets</a>, <a href="index.html#cmake-tools_deps">tools_deps</a>, <a href="index.html#cmake-working_directory">working_directory</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external library with CMake.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-build_args"></a>build_args</td><td align="left">Arguments for the CMake build command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-cache_entries"></a>cache_entries</td><td align="left">CMake cache entries to initialize (they will be passed with <code>-Dkey=value</code>) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-cmake_options"></a>cmake_options</td><td align="left"><strong>deprecated</strong>: Use <code>generate_args</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-env_vars"></a>env_vars</td><td align="left">CMake environment variable values to join with toolchain-defined. For example, additional <code>CXXFLAGS</code>.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-generate_args"></a>generate_args</td><td align="left">Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: <code>["-G Ninja", "--debug-output", "-DFOO=bar"]</code>. Note that unless a generator (<code>-G</code>) argument is provided, the default generators are <a href="https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html">Unix Makefiles</a> for Linux and MacOS and <a href="https://cmake.org/cmake/help/latest/generator/Ninja.html">Ninja</a> for Windows.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-generate_crosstool_file"></a>generate_crosstool_file</td><td align="left">When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as <code>-Dkey=value</code> and environment variables). If <code>CMAKE_TOOLCHAIN_FILE</code> cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify <code>CMAKE_SYSTEM_NAME</code> in the cache_entries</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install"></a>install</td><td align="left">If True, the <code>cmake --install</code> comand will be performed after a build</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install_args"></a>install_args</td><td align="left">Arguments for the CMake install command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install_prefix"></a>install_prefix</td><td align="left">Relative install prefix to be passed to CMake in <code>-DCMAKE_INSTALL_PREFIX</code></td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-make_commands"></a>make_commands</td><td align="left"><strong>deprecated</strong>: Optional hard coded commands to replace the <code>cmake --build</code> commands. It's recommended to leave this empty and use the <code>targets</code> + <code>build_args</code> attributes.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-working_directory"></a>working_directory</td><td align="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#cmake_tool"></a></p>
|
||||||
|
<h2 id="cmake_tool"><a class="header" href="#cmake_tool">cmake_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake_tool(<a href="index.html#cmake_tool-name">name</a>, <a href="index.html#cmake_tool-srcs">srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building CMake. Invokes bootstrap script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#configure_make"></a></p>
|
||||||
|
<h2 id="configure_make"><a class="header" href="#configure_make">configure_make</a></h2>
|
||||||
|
<pre>
|
||||||
|
configure_make(<a href="index.html#configure_make-name">name</a>, <a href="index.html#configure_make-additional_inputs">additional_inputs</a>, <a href="index.html#configure_make-additional_tools">additional_tools</a>, <a href="index.html#configure_make-alwayslink">alwayslink</a>, <a href="index.html#configure_make-args">args</a>, <a href="index.html#configure_make-autoconf">autoconf</a>,
|
||||||
|
<a href="index.html#configure_make-autoconf_env_vars">autoconf_env_vars</a>, <a href="index.html#configure_make-autoconf_options">autoconf_options</a>, <a href="index.html#configure_make-autogen">autogen</a>, <a href="index.html#configure_make-autogen_command">autogen_command</a>, <a href="index.html#configure_make-autogen_env_vars">autogen_env_vars</a>,
|
||||||
|
<a href="index.html#configure_make-autogen_options">autogen_options</a>, <a href="index.html#configure_make-autoreconf">autoreconf</a>, <a href="index.html#configure_make-autoreconf_env_vars">autoreconf_env_vars</a>, <a href="index.html#configure_make-autoreconf_options">autoreconf_options</a>, <a href="index.html#configure_make-binaries">binaries</a>,
|
||||||
|
<a href="index.html#configure_make-configure_command">configure_command</a>, <a href="index.html#configure_make-configure_env_vars">configure_env_vars</a>, <a href="index.html#configure_make-configure_in_place">configure_in_place</a>, <a href="index.html#configure_make-configure_options">configure_options</a>, <a href="index.html#configure_make-data">data</a>,
|
||||||
|
<a href="index.html#configure_make-defines">defines</a>, <a href="index.html#configure_make-deps">deps</a>, <a href="index.html#configure_make-env">env</a>, <a href="index.html#configure_make-headers_only">headers_only</a>, <a href="index.html#configure_make-install_prefix">install_prefix</a>, <a href="index.html#configure_make-interface_libraries">interface_libraries</a>, <a href="index.html#configure_make-lib_name">lib_name</a>,
|
||||||
|
<a href="index.html#configure_make-lib_source">lib_source</a>, <a href="index.html#configure_make-linkopts">linkopts</a>, <a href="index.html#configure_make-make_commands">make_commands</a>, <a href="index.html#configure_make-out_bin_dir">out_bin_dir</a>, <a href="index.html#configure_make-out_binaries">out_binaries</a>, <a href="index.html#configure_make-out_headers_only">out_headers_only</a>,
|
||||||
|
<a href="index.html#configure_make-out_include_dir">out_include_dir</a>, <a href="index.html#configure_make-out_interface_libs">out_interface_libs</a>, <a href="index.html#configure_make-out_lib_dir">out_lib_dir</a>, <a href="index.html#configure_make-out_shared_libs">out_shared_libs</a>, <a href="index.html#configure_make-out_static_libs">out_static_libs</a>,
|
||||||
|
<a href="index.html#configure_make-postfix_script">postfix_script</a>, <a href="index.html#configure_make-shared_libraries">shared_libraries</a>, <a href="index.html#configure_make-static_libraries">static_libraries</a>, <a href="index.html#configure_make-targets">targets</a>, <a href="index.html#configure_make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="configure_make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf"></a>autoconf</td><td align="left">Set to True if 'autoconf' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_env_vars"></a>autoconf_env_vars</td><td align="left">Environment variables to be set for 'autoconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_options"></a>autoconf_options</td><td align="left">Any options to be put in the 'autoconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen"></a>autogen</td><td align="left">Set to True if 'autogen.sh' should be invoked before 'configure', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_command"></a>autogen_command</td><td align="left">The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.</td><td align="left">String</td><td align="left">optional</td><td align="left">"autogen.sh"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_env_vars"></a>autogen_env_vars</td><td align="left">Environment variables to be set for 'autogen' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_options"></a>autogen_options</td><td align="left">Any options to be put in the 'autogen.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf"></a>autoreconf</td><td align="left">Set to True if 'autoreconf' should be invoked before 'configure.', currently requires 'configure_in_place' to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_env_vars"></a>autoreconf_env_vars</td><td align="left">Environment variables to be set for 'autoreconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_options"></a>autoreconf_options</td><td align="left">Any options to be put in the 'autoreconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_command"></a>configure_command</td><td align="left">The name of the configuration script file, default: configure. The file must be in the root of the source directory.</td><td align="left">String</td><td align="left">optional</td><td align="left">"configure"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_env_vars"></a>configure_env_vars</td><td align="left">Environment variables to be set for the 'configure' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_in_place"></a>configure_in_place</td><td align="left">Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_options"></a>configure_options</td><td align="left">Any options to be put on the 'configure' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-make_commands"></a>make_commands</td><td align="left">Optinal make commands, defaults to ["make", "make install"]</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make"></a></p>
|
||||||
|
<h2 id="make"><a class="header" href="#make">make</a></h2>
|
||||||
|
<pre>
|
||||||
|
make(<a href="index.html#make-name">name</a>, <a href="index.html#make-additional_inputs">additional_inputs</a>, <a href="index.html#make-additional_tools">additional_tools</a>, <a href="index.html#make-alwayslink">alwayslink</a>, <a href="index.html#make-args">args</a>, <a href="index.html#make-binaries">binaries</a>, <a href="index.html#make-data">data</a>, <a href="index.html#make-defines">defines</a>, <a href="index.html#make-deps">deps</a>,
|
||||||
|
<a href="index.html#make-env">env</a>, <a href="index.html#make-headers_only">headers_only</a>, <a href="index.html#make-interface_libraries">interface_libraries</a>, <a href="index.html#make-keep_going">keep_going</a>, <a href="index.html#make-lib_name">lib_name</a>, <a href="index.html#make-lib_source">lib_source</a>, <a href="index.html#make-linkopts">linkopts</a>,
|
||||||
|
<a href="index.html#make-make_commands">make_commands</a>, <a href="index.html#make-make_env_vars">make_env_vars</a>, <a href="index.html#make-out_bin_dir">out_bin_dir</a>, <a href="index.html#make-out_binaries">out_binaries</a>, <a href="index.html#make-out_headers_only">out_headers_only</a>, <a href="index.html#make-out_include_dir">out_include_dir</a>,
|
||||||
|
<a href="index.html#make-out_interface_libs">out_interface_libs</a>, <a href="index.html#make-out_lib_dir">out_lib_dir</a>, <a href="index.html#make-out_shared_libs">out_shared_libs</a>, <a href="index.html#make-out_static_libs">out_static_libs</a>, <a href="index.html#make-postfix_script">postfix_script</a>, <a href="index.html#make-prefix">prefix</a>,
|
||||||
|
<a href="index.html#make-shared_libraries">shared_libraries</a>, <a href="index.html#make-static_libraries">static_libraries</a>, <a href="index.html#make-targets">targets</a>, <a href="index.html#make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with prefix="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-keep_going"></a>keep_going</td><td align="left"><strong>deprecated</strong>: To maintain this behavior, pass <code>-k</code> to the <code>args</code> attribute when not using the <code>make_commands</code> attribute.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_commands"></a>make_commands</td><td align="left"><strong>deprecated</strong>: A list of hard coded bash commands for building source code. It's recommended to leave this empty and use the <code>targets</code> + <code>args</code> attributes.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-make_env_vars"></a>make_env_vars</td><td align="left"><strong>deprecated</strong>: Use the <code>env</code> attribute</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-prefix"></a>prefix</td><td align="left"><strong>deprecated</strong>: To maintain this behavior, pass <code>PREFIX=<value></code> to the <code>args</code> attribute</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#make_tool"></a></p>
|
||||||
|
<h2 id="make_tool"><a class="header" href="#make_tool">make_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
make_tool(<a href="index.html#make_tool-name">name</a>, <a href="index.html#make_tool-srcs">srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Make. Invokes configure script and make install.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="make_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="make_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#native_tool_toolchain"></a></p>
|
||||||
|
<h2 id="native_tool_toolchain"><a class="header" href="#native_tool_toolchain">native_tool_toolchain</a></h2>
|
||||||
|
<pre>
|
||||||
|
native_tool_toolchain(<a href="index.html#native_tool_toolchain-name">name</a>, <a href="index.html#native_tool_toolchain-path">path</a>, <a href="index.html#native_tool_toolchain-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types <code>@rules_foreign_cc//toolchains:cmake_toolchain</code> and <code>@rules_foreign_cc//toolchains:ninja_toolchain</code>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="native_tool_toolchain-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">optional</td><td align="left">None</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja"></a></p>
|
||||||
|
<h2 id="ninja"><a class="header" href="#ninja">ninja</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja(<a href="index.html#ninja-name">name</a>, <a href="index.html#ninja-additional_inputs">additional_inputs</a>, <a href="index.html#ninja-additional_tools">additional_tools</a>, <a href="index.html#ninja-alwayslink">alwayslink</a>, <a href="index.html#ninja-args">args</a>, <a href="index.html#ninja-binaries">binaries</a>, <a href="index.html#ninja-data">data</a>, <a href="index.html#ninja-defines">defines</a>, <a href="index.html#ninja-deps">deps</a>,
|
||||||
|
<a href="index.html#ninja-directory">directory</a>, <a href="index.html#ninja-env">env</a>, <a href="index.html#ninja-headers_only">headers_only</a>, <a href="index.html#ninja-interface_libraries">interface_libraries</a>, <a href="index.html#ninja-lib_name">lib_name</a>, <a href="index.html#ninja-lib_source">lib_source</a>, <a href="index.html#ninja-linkopts">linkopts</a>, <a href="index.html#ninja-out_bin_dir">out_bin_dir</a>,
|
||||||
|
<a href="index.html#ninja-out_binaries">out_binaries</a>, <a href="index.html#ninja-out_headers_only">out_headers_only</a>, <a href="index.html#ninja-out_include_dir">out_include_dir</a>, <a href="index.html#ninja-out_interface_libs">out_interface_libs</a>, <a href="index.html#ninja-out_lib_dir">out_lib_dir</a>,
|
||||||
|
<a href="index.html#ninja-out_shared_libs">out_shared_libs</a>, <a href="index.html#ninja-out_static_libs">out_static_libs</a>, <a href="index.html#ninja-postfix_script">postfix_script</a>, <a href="index.html#ninja-shared_libraries">shared_libraries</a>, <a href="index.html#ninja-static_libraries">static_libraries</a>, <a href="index.html#ninja-targets">targets</a>,
|
||||||
|
<a href="index.html#ninja-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with <a href="https://ninja-build.org/">Ninja</a>.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>ninja</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-binaries"></a>binaries</td><td align="left"><strong>deprecated</strong>: Use <code>out_binaries</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-directory"></a>directory</td><td align="left">A directory to pass as the <code>-C</code> argument. The rule will always use the root directory of the <code>lib_sources</code> attribute if this attribute is not set</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-env"></a>env</td><td align="left">Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-headers_only"></a>headers_only</td><td align="left"><strong>deprecated</strong>: Use <code>out_headers_only</code> instead.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-interface_libraries"></a>interface_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_interface_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-shared_libraries"></a>shared_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_shared_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-static_libraries"></a>static_libraries</td><td align="left"><strong>deprecated</strong>: Use <code>out_static_libs</code> instead.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ninja_tool"></a></p>
|
||||||
|
<h2 id="ninja_tool"><a class="header" href="#ninja_tool">ninja_tool</a></h2>
|
||||||
|
<pre>
|
||||||
|
ninja_tool(<a href="index.html#ninja_tool-name">name</a>, <a href="index.html#ninja_tool-srcs">srcs</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building Ninja. Invokes configure script.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="ninja_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcArtifact"></a></p>
|
||||||
|
<h2 id="foreignccartifact"><a class="header" href="#foreignccartifact">ForeignCcArtifact</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcArtifact(<a href="index.html#ForeignCcArtifact-bin_dir_name">bin_dir_name</a>, <a href="index.html#ForeignCcArtifact-gen_dir">gen_dir</a>, <a href="index.html#ForeignCcArtifact-include_dir_name">include_dir_name</a>, <a href="index.html#ForeignCcArtifact-lib_dir_name">lib_dir_name</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Groups information about the external library install directory,
|
||||||
|
and relative bin, include and lib directories.</p>
|
||||||
|
<p>Serves to pass transitive information about externally built artifacts up the dependency chain.</p>
|
||||||
|
<p>Can not be used as a top-level provider.
|
||||||
|
Instances of ForeignCcArtifact are incapsulated in a depset ForeignCcDeps#artifacts.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-bin_dir_name"></a>bin_dir_name</td><td align="left">Bin directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-gen_dir"></a>gen_dir</td><td align="left">Install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-include_dir_name"></a>include_dir_name</td><td align="left">Include directory, relative to install directory</td></tr>
|
||||||
|
<tr><td align="left"><a id="ForeignCcArtifact-lib_dir_name"></a>lib_dir_name</td><td align="left">Lib directory, relative to install directory</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ForeignCcDeps"></a></p>
|
||||||
|
<h2 id="foreignccdeps"><a class="header" href="#foreignccdeps">ForeignCcDeps</a></h2>
|
||||||
|
<pre>
|
||||||
|
ForeignCcDeps(<a href="index.html#ForeignCcDeps-artifacts">artifacts</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Provider to pass transitive information about external libraries.</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ForeignCcDeps-artifacts"></a>artifacts</td><td align="left">Depset of ForeignCcArtifact</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#ToolInfo"></a></p>
|
||||||
|
<h2 id="toolinfo"><a class="header" href="#toolinfo">ToolInfo</a></h2>
|
||||||
|
<pre>
|
||||||
|
ToolInfo(<a href="index.html#ToolInfo-path">path</a>, <a href="index.html#ToolInfo-target">target</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Information about the native tool</p>
|
||||||
|
<p><strong>FIELDS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td></tr>
|
||||||
|
<tr><td align="left"><a id="ToolInfo-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<p><a id="#rules_foreign_cc_dependencies"></a></p>
|
||||||
|
<h2 id="rules_foreign_cc_dependencies"><a class="header" href="#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></h2>
|
||||||
|
<pre>
|
||||||
|
rules_foreign_cc_dependencies(<a href="index.html#rules_foreign_cc_dependencies-native_tools_toolchains">native_tools_toolchains</a>, <a href="index.html#rules_foreign_cc_dependencies-register_default_tools">register_default_tools</a>, <a href="index.html#rules_foreign_cc_dependencies-cmake_version">cmake_version</a>,
|
||||||
|
<a href="index.html#rules_foreign_cc_dependencies-make_version">make_version</a>, <a href="index.html#rules_foreign_cc_dependencies-ninja_version">ninja_version</a>, <a href="index.html#rules_foreign_cc_dependencies-register_preinstalled_tools">register_preinstalled_tools</a>,
|
||||||
|
<a href="index.html#rules_foreign_cc_dependencies-register_built_tools">register_built_tools</a>, <a href="index.html#rules_foreign_cc_dependencies-additional_shell_toolchain_mappings">additional_shell_toolchain_mappings</a>,
|
||||||
|
<a href="index.html#rules_foreign_cc_dependencies-additional_shell_toolchain_package">additional_shell_toolchain_package</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Call this function from the WORKSPACE file to initialize rules_foreign_cc dependencies and let neccesary code generation happen (Code generation is needed to support different variants of the C++ Starlark API.).</p>
|
||||||
|
<p><strong>PARAMETERS</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-native_tools_toolchains"></a>native_tools_toolchains</td><td align="left">pass the toolchains for toolchain types '@rules_foreign_cc//toolchains:cmake_toolchain' and '@rules_foreign_cc//toolchains:ninja_toolchain' with the needed platform constraints. If you do not pass anything, registered default toolchains will be selected (see below).</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_default_tools"></a>register_default_tools</td><td align="left">If True, the cmake and ninja toolchains, calling corresponding preinstalled binaries by name (cmake, ninja) will be registered after 'native_tools_toolchains' without any platform constraints. The default is True.</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-cmake_version"></a>cmake_version</td><td align="left">The target version of the cmake toolchain if <code>register_default_tools</code> or <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"3.19.6"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-make_version"></a>make_version</td><td align="left">The target version of the default make toolchain if <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"4.3"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-ninja_version"></a>ninja_version</td><td align="left">The target version of the ninja toolchain if <code>register_default_tools</code> or <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"1.10.2"</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_preinstalled_tools"></a>register_preinstalled_tools</td><td align="left">If true, toolchains will be registered for the native built tools installed on the exec host</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_built_tools"></a>register_built_tools</td><td align="left">If true, toolchains that build the tools from source are registered</td><td align="left"><code>True</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_mappings"></a>additional_shell_toolchain_mappings</td><td align="left">Mappings of the shell toolchain functions to execution and target platforms constraints. Similar to what defined in @rules_foreign_cc//foreign_cc/private/shell_toolchain/toolchains:toolchain_mappings.bzl in the TOOLCHAIN_MAPPINGS list. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>[]</code></td></tr>
|
||||||
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-additional_shell_toolchain_package"></a>additional_shell_toolchain_package</td><td align="left">A package under which additional toolchains, referencing the generated data for the passed additonal_shell_toolchain_mappings, will be defined. This value is needed since register_toolchains() is called for these toolchains. Please refer to example in @rules_foreign_cc//toolchain_examples.</td><td align="left"><code>None</code></td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
|
||||||
|
|
||||||
|
<div style="clear: both"></div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.addEventListener('load', function() {
|
||||||
|
window.setTimeout(window.print, 100);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
483
0.2.0/searcher.js
Normal file
483
0.2.0/searcher.js
Normal file
|
|
@ -0,0 +1,483 @@
|
||||||
|
"use strict";
|
||||||
|
window.search = window.search || {};
|
||||||
|
(function search(search) {
|
||||||
|
// Search functionality
|
||||||
|
//
|
||||||
|
// You can use !hasFocus() to prevent keyhandling in your key
|
||||||
|
// event handlers while the user is typing their search.
|
||||||
|
|
||||||
|
if (!Mark || !elasticlunr) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
//IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
|
||||||
|
if (!String.prototype.startsWith) {
|
||||||
|
String.prototype.startsWith = function(search, pos) {
|
||||||
|
return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
var search_wrap = document.getElementById('search-wrapper'),
|
||||||
|
searchbar = document.getElementById('searchbar'),
|
||||||
|
searchbar_outer = document.getElementById('searchbar-outer'),
|
||||||
|
searchresults = document.getElementById('searchresults'),
|
||||||
|
searchresults_outer = document.getElementById('searchresults-outer'),
|
||||||
|
searchresults_header = document.getElementById('searchresults-header'),
|
||||||
|
searchicon = document.getElementById('search-toggle'),
|
||||||
|
content = document.getElementById('content'),
|
||||||
|
|
||||||
|
searchindex = null,
|
||||||
|
doc_urls = [],
|
||||||
|
results_options = {
|
||||||
|
teaser_word_count: 30,
|
||||||
|
limit_results: 30,
|
||||||
|
},
|
||||||
|
search_options = {
|
||||||
|
bool: "AND",
|
||||||
|
expand: true,
|
||||||
|
fields: {
|
||||||
|
title: {boost: 1},
|
||||||
|
body: {boost: 1},
|
||||||
|
breadcrumbs: {boost: 0}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
mark_exclude = [],
|
||||||
|
marker = new Mark(content),
|
||||||
|
current_searchterm = "",
|
||||||
|
URL_SEARCH_PARAM = 'search',
|
||||||
|
URL_MARK_PARAM = 'highlight',
|
||||||
|
teaser_count = 0,
|
||||||
|
|
||||||
|
SEARCH_HOTKEY_KEYCODE = 83,
|
||||||
|
ESCAPE_KEYCODE = 27,
|
||||||
|
DOWN_KEYCODE = 40,
|
||||||
|
UP_KEYCODE = 38,
|
||||||
|
SELECT_KEYCODE = 13;
|
||||||
|
|
||||||
|
function hasFocus() {
|
||||||
|
return searchbar === document.activeElement;
|
||||||
|
}
|
||||||
|
|
||||||
|
function removeChildren(elem) {
|
||||||
|
while (elem.firstChild) {
|
||||||
|
elem.removeChild(elem.firstChild);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper to parse a url into its building blocks.
|
||||||
|
function parseURL(url) {
|
||||||
|
var a = document.createElement('a');
|
||||||
|
a.href = url;
|
||||||
|
return {
|
||||||
|
source: url,
|
||||||
|
protocol: a.protocol.replace(':',''),
|
||||||
|
host: a.hostname,
|
||||||
|
port: a.port,
|
||||||
|
params: (function(){
|
||||||
|
var ret = {};
|
||||||
|
var seg = a.search.replace(/^\?/,'').split('&');
|
||||||
|
var len = seg.length, i = 0, s;
|
||||||
|
for (;i<len;i++) {
|
||||||
|
if (!seg[i]) { continue; }
|
||||||
|
s = seg[i].split('=');
|
||||||
|
ret[s[0]] = s[1];
|
||||||
|
}
|
||||||
|
return ret;
|
||||||
|
})(),
|
||||||
|
file: (a.pathname.match(/\/([^/?#]+)$/i) || [,''])[1],
|
||||||
|
hash: a.hash.replace('#',''),
|
||||||
|
path: a.pathname.replace(/^([^/])/,'/$1')
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper to recreate a url string from its building blocks.
|
||||||
|
function renderURL(urlobject) {
|
||||||
|
var url = urlobject.protocol + "://" + urlobject.host;
|
||||||
|
if (urlobject.port != "") {
|
||||||
|
url += ":" + urlobject.port;
|
||||||
|
}
|
||||||
|
url += urlobject.path;
|
||||||
|
var joiner = "?";
|
||||||
|
for(var prop in urlobject.params) {
|
||||||
|
if(urlobject.params.hasOwnProperty(prop)) {
|
||||||
|
url += joiner + prop + "=" + urlobject.params[prop];
|
||||||
|
joiner = "&";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (urlobject.hash != "") {
|
||||||
|
url += "#" + urlobject.hash;
|
||||||
|
}
|
||||||
|
return url;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper to escape html special chars for displaying the teasers
|
||||||
|
var escapeHTML = (function() {
|
||||||
|
var MAP = {
|
||||||
|
'&': '&',
|
||||||
|
'<': '<',
|
||||||
|
'>': '>',
|
||||||
|
'"': '"',
|
||||||
|
"'": '''
|
||||||
|
};
|
||||||
|
var repl = function(c) { return MAP[c]; };
|
||||||
|
return function(s) {
|
||||||
|
return s.replace(/[&<>'"]/g, repl);
|
||||||
|
};
|
||||||
|
})();
|
||||||
|
|
||||||
|
function formatSearchMetric(count, searchterm) {
|
||||||
|
if (count == 1) {
|
||||||
|
return count + " search result for '" + searchterm + "':";
|
||||||
|
} else if (count == 0) {
|
||||||
|
return "No search results for '" + searchterm + "'.";
|
||||||
|
} else {
|
||||||
|
return count + " search results for '" + searchterm + "':";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatSearchResult(result, searchterms) {
|
||||||
|
var teaser = makeTeaser(escapeHTML(result.doc.body), searchterms);
|
||||||
|
teaser_count++;
|
||||||
|
|
||||||
|
// The ?URL_MARK_PARAM= parameter belongs inbetween the page and the #heading-anchor
|
||||||
|
var url = doc_urls[result.ref].split("#");
|
||||||
|
if (url.length == 1) { // no anchor found
|
||||||
|
url.push("");
|
||||||
|
}
|
||||||
|
|
||||||
|
// encodeURIComponent escapes all chars that could allow an XSS except
|
||||||
|
// for '. Due to that we also manually replace ' with its url-encoded
|
||||||
|
// representation (%27).
|
||||||
|
var searchterms = encodeURIComponent(searchterms.join(" ")).replace(/\'/g, "%27");
|
||||||
|
|
||||||
|
return '<a href="' + path_to_root + url[0] + '?' + URL_MARK_PARAM + '=' + searchterms + '#' + url[1]
|
||||||
|
+ '" aria-details="teaser_' + teaser_count + '">' + result.doc.breadcrumbs + '</a>'
|
||||||
|
+ '<span class="teaser" id="teaser_' + teaser_count + '" aria-label="Search Result Teaser">'
|
||||||
|
+ teaser + '</span>';
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeTeaser(body, searchterms) {
|
||||||
|
// The strategy is as follows:
|
||||||
|
// First, assign a value to each word in the document:
|
||||||
|
// Words that correspond to search terms (stemmer aware): 40
|
||||||
|
// Normal words: 2
|
||||||
|
// First word in a sentence: 8
|
||||||
|
// Then use a sliding window with a constant number of words and count the
|
||||||
|
// sum of the values of the words within the window. Then use the window that got the
|
||||||
|
// maximum sum. If there are multiple maximas, then get the last one.
|
||||||
|
// Enclose the terms in <em>.
|
||||||
|
var stemmed_searchterms = searchterms.map(function(w) {
|
||||||
|
return elasticlunr.stemmer(w.toLowerCase());
|
||||||
|
});
|
||||||
|
var searchterm_weight = 40;
|
||||||
|
var weighted = []; // contains elements of ["word", weight, index_in_document]
|
||||||
|
// split in sentences, then words
|
||||||
|
var sentences = body.toLowerCase().split('. ');
|
||||||
|
var index = 0;
|
||||||
|
var value = 0;
|
||||||
|
var searchterm_found = false;
|
||||||
|
for (var sentenceindex in sentences) {
|
||||||
|
var words = sentences[sentenceindex].split(' ');
|
||||||
|
value = 8;
|
||||||
|
for (var wordindex in words) {
|
||||||
|
var word = words[wordindex];
|
||||||
|
if (word.length > 0) {
|
||||||
|
for (var searchtermindex in stemmed_searchterms) {
|
||||||
|
if (elasticlunr.stemmer(word).startsWith(stemmed_searchterms[searchtermindex])) {
|
||||||
|
value = searchterm_weight;
|
||||||
|
searchterm_found = true;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
weighted.push([word, value, index]);
|
||||||
|
value = 2;
|
||||||
|
}
|
||||||
|
index += word.length;
|
||||||
|
index += 1; // ' ' or '.' if last word in sentence
|
||||||
|
};
|
||||||
|
index += 1; // because we split at a two-char boundary '. '
|
||||||
|
};
|
||||||
|
|
||||||
|
if (weighted.length == 0) {
|
||||||
|
return body;
|
||||||
|
}
|
||||||
|
|
||||||
|
var window_weight = [];
|
||||||
|
var window_size = Math.min(weighted.length, results_options.teaser_word_count);
|
||||||
|
|
||||||
|
var cur_sum = 0;
|
||||||
|
for (var wordindex = 0; wordindex < window_size; wordindex++) {
|
||||||
|
cur_sum += weighted[wordindex][1];
|
||||||
|
};
|
||||||
|
window_weight.push(cur_sum);
|
||||||
|
for (var wordindex = 0; wordindex < weighted.length - window_size; wordindex++) {
|
||||||
|
cur_sum -= weighted[wordindex][1];
|
||||||
|
cur_sum += weighted[wordindex + window_size][1];
|
||||||
|
window_weight.push(cur_sum);
|
||||||
|
};
|
||||||
|
|
||||||
|
if (searchterm_found) {
|
||||||
|
var max_sum = 0;
|
||||||
|
var max_sum_window_index = 0;
|
||||||
|
// backwards
|
||||||
|
for (var i = window_weight.length - 1; i >= 0; i--) {
|
||||||
|
if (window_weight[i] > max_sum) {
|
||||||
|
max_sum = window_weight[i];
|
||||||
|
max_sum_window_index = i;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
} else {
|
||||||
|
max_sum_window_index = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// add <em/> around searchterms
|
||||||
|
var teaser_split = [];
|
||||||
|
var index = weighted[max_sum_window_index][2];
|
||||||
|
for (var i = max_sum_window_index; i < max_sum_window_index+window_size; i++) {
|
||||||
|
var word = weighted[i];
|
||||||
|
if (index < word[2]) {
|
||||||
|
// missing text from index to start of `word`
|
||||||
|
teaser_split.push(body.substring(index, word[2]));
|
||||||
|
index = word[2];
|
||||||
|
}
|
||||||
|
if (word[1] == searchterm_weight) {
|
||||||
|
teaser_split.push("<em>")
|
||||||
|
}
|
||||||
|
index = word[2] + word[0].length;
|
||||||
|
teaser_split.push(body.substring(word[2], index));
|
||||||
|
if (word[1] == searchterm_weight) {
|
||||||
|
teaser_split.push("</em>")
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return teaser_split.join('');
|
||||||
|
}
|
||||||
|
|
||||||
|
function init(config) {
|
||||||
|
results_options = config.results_options;
|
||||||
|
search_options = config.search_options;
|
||||||
|
searchbar_outer = config.searchbar_outer;
|
||||||
|
doc_urls = config.doc_urls;
|
||||||
|
searchindex = elasticlunr.Index.load(config.index);
|
||||||
|
|
||||||
|
// Set up events
|
||||||
|
searchicon.addEventListener('click', function(e) { searchIconClickHandler(); }, false);
|
||||||
|
searchbar.addEventListener('keyup', function(e) { searchbarKeyUpHandler(); }, false);
|
||||||
|
document.addEventListener('keydown', function(e) { globalKeyHandler(e); }, false);
|
||||||
|
// If the user uses the browser buttons, do the same as if a reload happened
|
||||||
|
window.onpopstate = function(e) { doSearchOrMarkFromUrl(); };
|
||||||
|
// Suppress "submit" events so the page doesn't reload when the user presses Enter
|
||||||
|
document.addEventListener('submit', function(e) { e.preventDefault(); }, false);
|
||||||
|
|
||||||
|
// If reloaded, do the search or mark again, depending on the current url parameters
|
||||||
|
doSearchOrMarkFromUrl();
|
||||||
|
}
|
||||||
|
|
||||||
|
function unfocusSearchbar() {
|
||||||
|
// hacky, but just focusing a div only works once
|
||||||
|
var tmp = document.createElement('input');
|
||||||
|
tmp.setAttribute('style', 'position: absolute; opacity: 0;');
|
||||||
|
searchicon.appendChild(tmp);
|
||||||
|
tmp.focus();
|
||||||
|
tmp.remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
// On reload or browser history backwards/forwards events, parse the url and do search or mark
|
||||||
|
function doSearchOrMarkFromUrl() {
|
||||||
|
// Check current URL for search request
|
||||||
|
var url = parseURL(window.location.href);
|
||||||
|
if (url.params.hasOwnProperty(URL_SEARCH_PARAM)
|
||||||
|
&& url.params[URL_SEARCH_PARAM] != "") {
|
||||||
|
showSearch(true);
|
||||||
|
searchbar.value = decodeURIComponent(
|
||||||
|
(url.params[URL_SEARCH_PARAM]+'').replace(/\+/g, '%20'));
|
||||||
|
searchbarKeyUpHandler(); // -> doSearch()
|
||||||
|
} else {
|
||||||
|
showSearch(false);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url.params.hasOwnProperty(URL_MARK_PARAM)) {
|
||||||
|
var words = decodeURIComponent(url.params[URL_MARK_PARAM]).split(' ');
|
||||||
|
marker.mark(words, {
|
||||||
|
exclude: mark_exclude
|
||||||
|
});
|
||||||
|
|
||||||
|
var markers = document.querySelectorAll("mark");
|
||||||
|
function hide() {
|
||||||
|
for (var i = 0; i < markers.length; i++) {
|
||||||
|
markers[i].classList.add("fade-out");
|
||||||
|
window.setTimeout(function(e) { marker.unmark(); }, 300);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (var i = 0; i < markers.length; i++) {
|
||||||
|
markers[i].addEventListener('click', hide);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Eventhandler for keyevents on `document`
|
||||||
|
function globalKeyHandler(e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey || e.target.type === 'textarea' || e.target.type === 'text') { return; }
|
||||||
|
|
||||||
|
if (e.keyCode === ESCAPE_KEYCODE) {
|
||||||
|
e.preventDefault();
|
||||||
|
searchbar.classList.remove("active");
|
||||||
|
setSearchUrlParameters("",
|
||||||
|
(searchbar.value.trim() !== "") ? "push" : "replace");
|
||||||
|
if (hasFocus()) {
|
||||||
|
unfocusSearchbar();
|
||||||
|
}
|
||||||
|
showSearch(false);
|
||||||
|
marker.unmark();
|
||||||
|
} else if (!hasFocus() && e.keyCode === SEARCH_HOTKEY_KEYCODE) {
|
||||||
|
e.preventDefault();
|
||||||
|
showSearch(true);
|
||||||
|
window.scrollTo(0, 0);
|
||||||
|
searchbar.select();
|
||||||
|
} else if (hasFocus() && e.keyCode === DOWN_KEYCODE) {
|
||||||
|
e.preventDefault();
|
||||||
|
unfocusSearchbar();
|
||||||
|
searchresults.firstElementChild.classList.add("focus");
|
||||||
|
} else if (!hasFocus() && (e.keyCode === DOWN_KEYCODE
|
||||||
|
|| e.keyCode === UP_KEYCODE
|
||||||
|
|| e.keyCode === SELECT_KEYCODE)) {
|
||||||
|
// not `:focus` because browser does annoying scrolling
|
||||||
|
var focused = searchresults.querySelector("li.focus");
|
||||||
|
if (!focused) return;
|
||||||
|
e.preventDefault();
|
||||||
|
if (e.keyCode === DOWN_KEYCODE) {
|
||||||
|
var next = focused.nextElementSibling;
|
||||||
|
if (next) {
|
||||||
|
focused.classList.remove("focus");
|
||||||
|
next.classList.add("focus");
|
||||||
|
}
|
||||||
|
} else if (e.keyCode === UP_KEYCODE) {
|
||||||
|
focused.classList.remove("focus");
|
||||||
|
var prev = focused.previousElementSibling;
|
||||||
|
if (prev) {
|
||||||
|
prev.classList.add("focus");
|
||||||
|
} else {
|
||||||
|
searchbar.select();
|
||||||
|
}
|
||||||
|
} else { // SELECT_KEYCODE
|
||||||
|
window.location.assign(focused.querySelector('a'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function showSearch(yes) {
|
||||||
|
if (yes) {
|
||||||
|
search_wrap.classList.remove('hidden');
|
||||||
|
searchicon.setAttribute('aria-expanded', 'true');
|
||||||
|
} else {
|
||||||
|
search_wrap.classList.add('hidden');
|
||||||
|
searchicon.setAttribute('aria-expanded', 'false');
|
||||||
|
var results = searchresults.children;
|
||||||
|
for (var i = 0; i < results.length; i++) {
|
||||||
|
results[i].classList.remove("focus");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function showResults(yes) {
|
||||||
|
if (yes) {
|
||||||
|
searchresults_outer.classList.remove('hidden');
|
||||||
|
} else {
|
||||||
|
searchresults_outer.classList.add('hidden');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Eventhandler for search icon
|
||||||
|
function searchIconClickHandler() {
|
||||||
|
if (search_wrap.classList.contains('hidden')) {
|
||||||
|
showSearch(true);
|
||||||
|
window.scrollTo(0, 0);
|
||||||
|
searchbar.select();
|
||||||
|
} else {
|
||||||
|
showSearch(false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Eventhandler for keyevents while the searchbar is focused
|
||||||
|
function searchbarKeyUpHandler() {
|
||||||
|
var searchterm = searchbar.value.trim();
|
||||||
|
if (searchterm != "") {
|
||||||
|
searchbar.classList.add("active");
|
||||||
|
doSearch(searchterm);
|
||||||
|
} else {
|
||||||
|
searchbar.classList.remove("active");
|
||||||
|
showResults(false);
|
||||||
|
removeChildren(searchresults);
|
||||||
|
}
|
||||||
|
|
||||||
|
setSearchUrlParameters(searchterm, "push_if_new_search_else_replace");
|
||||||
|
|
||||||
|
// Remove marks
|
||||||
|
marker.unmark();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update current url with ?URL_SEARCH_PARAM= parameter, remove ?URL_MARK_PARAM and #heading-anchor .
|
||||||
|
// `action` can be one of "push", "replace", "push_if_new_search_else_replace"
|
||||||
|
// and replaces or pushes a new browser history item.
|
||||||
|
// "push_if_new_search_else_replace" pushes if there is no `?URL_SEARCH_PARAM=abc` yet.
|
||||||
|
function setSearchUrlParameters(searchterm, action) {
|
||||||
|
var url = parseURL(window.location.href);
|
||||||
|
var first_search = ! url.params.hasOwnProperty(URL_SEARCH_PARAM);
|
||||||
|
if (searchterm != "" || action == "push_if_new_search_else_replace") {
|
||||||
|
url.params[URL_SEARCH_PARAM] = searchterm;
|
||||||
|
delete url.params[URL_MARK_PARAM];
|
||||||
|
url.hash = "";
|
||||||
|
} else {
|
||||||
|
delete url.params[URL_MARK_PARAM];
|
||||||
|
delete url.params[URL_SEARCH_PARAM];
|
||||||
|
}
|
||||||
|
// A new search will also add a new history item, so the user can go back
|
||||||
|
// to the page prior to searching. A updated search term will only replace
|
||||||
|
// the url.
|
||||||
|
if (action == "push" || (action == "push_if_new_search_else_replace" && first_search) ) {
|
||||||
|
history.pushState({}, document.title, renderURL(url));
|
||||||
|
} else if (action == "replace" || (action == "push_if_new_search_else_replace" && !first_search) ) {
|
||||||
|
history.replaceState({}, document.title, renderURL(url));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function doSearch(searchterm) {
|
||||||
|
|
||||||
|
// Don't search the same twice
|
||||||
|
if (current_searchterm == searchterm) { return; }
|
||||||
|
else { current_searchterm = searchterm; }
|
||||||
|
|
||||||
|
if (searchindex == null) { return; }
|
||||||
|
|
||||||
|
// Do the actual search
|
||||||
|
var results = searchindex.search(searchterm, search_options);
|
||||||
|
var resultcount = Math.min(results.length, results_options.limit_results);
|
||||||
|
|
||||||
|
// Display search metrics
|
||||||
|
searchresults_header.innerText = formatSearchMetric(resultcount, searchterm);
|
||||||
|
|
||||||
|
// Clear and insert results
|
||||||
|
var searchterms = searchterm.split(' ');
|
||||||
|
removeChildren(searchresults);
|
||||||
|
for(var i = 0; i < resultcount ; i++){
|
||||||
|
var resultElem = document.createElement('li');
|
||||||
|
resultElem.innerHTML = formatSearchResult(results[i], searchterms);
|
||||||
|
searchresults.appendChild(resultElem);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display results
|
||||||
|
showResults(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
fetch(path_to_root + 'searchindex.json')
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(json => init(json))
|
||||||
|
.catch(error => { // Try to load searchindex.js if fetch failed
|
||||||
|
var script = document.createElement('script');
|
||||||
|
script.src = path_to_root + 'searchindex.js';
|
||||||
|
script.onload = () => init(window.search);
|
||||||
|
document.head.appendChild(script);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Exported functions
|
||||||
|
search.hasFocus = hasFocus;
|
||||||
|
})(window.search);
|
||||||
1
0.2.0/searchindex.js
Normal file
1
0.2.0/searchindex.js
Normal file
File diff suppressed because one or more lines are too long
1
0.2.0/searchindex.json
Normal file
1
0.2.0/searchindex.json
Normal file
File diff suppressed because one or more lines are too long
104
0.2.0/tomorrow-night.css
Normal file
104
0.2.0/tomorrow-night.css
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
/* Tomorrow Night Theme */
|
||||||
|
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
||||||
|
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
|
||||||
|
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
||||||
|
|
||||||
|
/* Tomorrow Comment */
|
||||||
|
.hljs-comment {
|
||||||
|
color: #969896;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Red */
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-tag,
|
||||||
|
.hljs-regexp,
|
||||||
|
.ruby .hljs-constant,
|
||||||
|
.xml .hljs-tag .hljs-title,
|
||||||
|
.xml .hljs-pi,
|
||||||
|
.xml .hljs-doctype,
|
||||||
|
.html .hljs-doctype,
|
||||||
|
.css .hljs-id,
|
||||||
|
.css .hljs-class,
|
||||||
|
.css .hljs-pseudo {
|
||||||
|
color: #cc6666;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Orange */
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-preprocessor,
|
||||||
|
.hljs-pragma,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-params,
|
||||||
|
.hljs-constant {
|
||||||
|
color: #de935f;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Yellow */
|
||||||
|
.ruby .hljs-class .hljs-title,
|
||||||
|
.css .hljs-rule .hljs-attribute {
|
||||||
|
color: #f0c674;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Green */
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-value,
|
||||||
|
.hljs-inheritance,
|
||||||
|
.hljs-header,
|
||||||
|
.hljs-name,
|
||||||
|
.ruby .hljs-symbol,
|
||||||
|
.xml .hljs-cdata {
|
||||||
|
color: #b5bd68;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Aqua */
|
||||||
|
.hljs-title,
|
||||||
|
.css .hljs-hexcolor {
|
||||||
|
color: #8abeb7;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Blue */
|
||||||
|
.hljs-function,
|
||||||
|
.python .hljs-decorator,
|
||||||
|
.python .hljs-title,
|
||||||
|
.ruby .hljs-function .hljs-title,
|
||||||
|
.ruby .hljs-title .hljs-keyword,
|
||||||
|
.perl .hljs-sub,
|
||||||
|
.javascript .hljs-title,
|
||||||
|
.coffeescript .hljs-title {
|
||||||
|
color: #81a2be;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Purple */
|
||||||
|
.hljs-keyword,
|
||||||
|
.javascript .hljs-function {
|
||||||
|
color: #b294bb;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
background: #1d1f21;
|
||||||
|
color: #c5c8c6;
|
||||||
|
padding: 0.5em;
|
||||||
|
-webkit-text-size-adjust: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.coffeescript .javascript,
|
||||||
|
.javascript .xml,
|
||||||
|
.tex .hljs-formula,
|
||||||
|
.xml .javascript,
|
||||||
|
.xml .vbscript,
|
||||||
|
.xml .css,
|
||||||
|
.xml .hljs-cdata {
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
color: #718c00;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
color: #c82829;
|
||||||
|
}
|
||||||
1
0.3.0/.nojekyll
Normal file
1
0.3.0/.nojekyll
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
This file makes sure that Github Pages doesn't process mdBook's output.
|
||||||
190
0.3.0/404.html
Normal file
190
0.3.0/404.html
Normal file
|
|
@ -0,0 +1,190 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title></title>
|
||||||
|
<base href="/">
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="cmake.html"><strong aria-hidden="true">1.1.</strong> cmake</a></li><li class="chapter-item expanded "><a href="configure_make.html"><strong aria-hidden="true">1.2.</strong> configure_make</a></li><li class="chapter-item expanded "><a href="make.html"><strong aria-hidden="true">1.3.</strong> make</a></li><li class="chapter-item expanded "><a href="ninja.html"><strong aria-hidden="true">1.4.</strong> ninja</a></li><li class="chapter-item expanded "><a href="flatten.html"><strong aria-hidden="true">1.5.</strong> Full API</a></li></ol></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
|
||||||
|
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
|
||||||
|
|
||||||
|
<div style="clear: both"></div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||||
|
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
4
0.3.0/FontAwesome/css/font-awesome.css
vendored
Normal file
4
0.3.0/FontAwesome/css/font-awesome.css
vendored
Normal file
File diff suppressed because one or more lines are too long
BIN
0.3.0/FontAwesome/fonts/FontAwesome.ttf
Normal file
BIN
0.3.0/FontAwesome/fonts/FontAwesome.ttf
Normal file
Binary file not shown.
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.eot
Normal file
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.eot
Normal file
Binary file not shown.
2671
0.3.0/FontAwesome/fonts/fontawesome-webfont.svg
Normal file
2671
0.3.0/FontAwesome/fonts/fontawesome-webfont.svg
Normal file
File diff suppressed because it is too large
Load diff
|
After Width: | Height: | Size: 434 KiB |
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.ttf
Normal file
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.ttf
Normal file
Binary file not shown.
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.woff
Normal file
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.woff
Normal file
Binary file not shown.
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.woff2
Normal file
BIN
0.3.0/FontAwesome/fonts/fontawesome-webfont.woff2
Normal file
Binary file not shown.
79
0.3.0/ayu-highlight.css
Normal file
79
0.3.0/ayu-highlight.css
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
/*
|
||||||
|
Based off of the Ayu theme
|
||||||
|
Original by Dempfi (https://github.com/dempfi/ayu)
|
||||||
|
*/
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
background: #191f26;
|
||||||
|
color: #e6e1cf;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-quote {
|
||||||
|
color: #5c6773;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-attr,
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-link,
|
||||||
|
.hljs-selector-id,
|
||||||
|
.hljs-selector-class {
|
||||||
|
color: #ff7733;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-meta,
|
||||||
|
.hljs-builtin-name,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-type,
|
||||||
|
.hljs-params {
|
||||||
|
color: #ffee99;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-bullet {
|
||||||
|
color: #b8cc52;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-title,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-section {
|
||||||
|
color: #ffb454;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-selector-tag,
|
||||||
|
.hljs-symbol {
|
||||||
|
color: #ff7733;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-name {
|
||||||
|
color: #36a3d9;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-tag {
|
||||||
|
color: #00568d;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-emphasis {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
color: #91b362;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
color: #d96c75;
|
||||||
|
}
|
||||||
660
0.3.0/book.js
Normal file
660
0.3.0/book.js
Normal file
|
|
@ -0,0 +1,660 @@
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
// Fix back button cache problem
|
||||||
|
window.onunload = function () { };
|
||||||
|
|
||||||
|
// Global variable, shared between modules
|
||||||
|
function playground_text(playground) {
|
||||||
|
let code_block = playground.querySelector("code");
|
||||||
|
|
||||||
|
if (window.ace && code_block.classList.contains("editable")) {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
return editor.getValue();
|
||||||
|
} else {
|
||||||
|
return code_block.textContent;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
(function codeSnippets() {
|
||||||
|
function fetch_with_timeout(url, options, timeout = 6000) {
|
||||||
|
return Promise.race([
|
||||||
|
fetch(url, options),
|
||||||
|
new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), timeout))
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
var playgrounds = Array.from(document.querySelectorAll(".playground"));
|
||||||
|
if (playgrounds.length > 0) {
|
||||||
|
fetch_with_timeout("https://play.rust-lang.org/meta/crates", {
|
||||||
|
headers: {
|
||||||
|
'Content-Type': "application/json",
|
||||||
|
},
|
||||||
|
method: 'POST',
|
||||||
|
mode: 'cors',
|
||||||
|
})
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(response => {
|
||||||
|
// get list of crates available in the rust playground
|
||||||
|
let playground_crates = response.crates.map(item => item["id"]);
|
||||||
|
playgrounds.forEach(block => handle_crate_list_update(block, playground_crates));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function handle_crate_list_update(playground_block, playground_crates) {
|
||||||
|
// update the play buttons after receiving the response
|
||||||
|
update_play_button(playground_block, playground_crates);
|
||||||
|
|
||||||
|
// and install on change listener to dynamically update ACE editors
|
||||||
|
if (window.ace) {
|
||||||
|
let code_block = playground_block.querySelector("code");
|
||||||
|
if (code_block.classList.contains("editable")) {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
editor.addEventListener("change", function (e) {
|
||||||
|
update_play_button(playground_block, playground_crates);
|
||||||
|
});
|
||||||
|
// add Ctrl-Enter command to execute rust code
|
||||||
|
editor.commands.addCommand({
|
||||||
|
name: "run",
|
||||||
|
bindKey: {
|
||||||
|
win: "Ctrl-Enter",
|
||||||
|
mac: "Ctrl-Enter"
|
||||||
|
},
|
||||||
|
exec: _editor => run_rust_code(playground_block)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// updates the visibility of play button based on `no_run` class and
|
||||||
|
// used crates vs ones available on http://play.rust-lang.org
|
||||||
|
function update_play_button(pre_block, playground_crates) {
|
||||||
|
var play_button = pre_block.querySelector(".play-button");
|
||||||
|
|
||||||
|
// skip if code is `no_run`
|
||||||
|
if (pre_block.querySelector('code').classList.contains("no_run")) {
|
||||||
|
play_button.classList.add("hidden");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// get list of `extern crate`'s from snippet
|
||||||
|
var txt = playground_text(pre_block);
|
||||||
|
var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
|
||||||
|
var snippet_crates = [];
|
||||||
|
var item;
|
||||||
|
while (item = re.exec(txt)) {
|
||||||
|
snippet_crates.push(item[1]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if all used crates are available on play.rust-lang.org
|
||||||
|
var all_available = snippet_crates.every(function (elem) {
|
||||||
|
return playground_crates.indexOf(elem) > -1;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (all_available) {
|
||||||
|
play_button.classList.remove("hidden");
|
||||||
|
} else {
|
||||||
|
play_button.classList.add("hidden");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function run_rust_code(code_block) {
|
||||||
|
var result_block = code_block.querySelector(".result");
|
||||||
|
if (!result_block) {
|
||||||
|
result_block = document.createElement('code');
|
||||||
|
result_block.className = 'result hljs language-bash';
|
||||||
|
|
||||||
|
code_block.append(result_block);
|
||||||
|
}
|
||||||
|
|
||||||
|
let text = playground_text(code_block);
|
||||||
|
let classes = code_block.querySelector('code').classList;
|
||||||
|
let has_2018 = classes.contains("edition2018");
|
||||||
|
let edition = has_2018 ? "2018" : "2015";
|
||||||
|
|
||||||
|
var params = {
|
||||||
|
version: "stable",
|
||||||
|
optimize: "0",
|
||||||
|
code: text,
|
||||||
|
edition: edition
|
||||||
|
};
|
||||||
|
|
||||||
|
if (text.indexOf("#![feature") !== -1) {
|
||||||
|
params.version = "nightly";
|
||||||
|
}
|
||||||
|
|
||||||
|
result_block.innerText = "Running...";
|
||||||
|
|
||||||
|
fetch_with_timeout("https://play.rust-lang.org/evaluate.json", {
|
||||||
|
headers: {
|
||||||
|
'Content-Type': "application/json",
|
||||||
|
},
|
||||||
|
method: 'POST',
|
||||||
|
mode: 'cors',
|
||||||
|
body: JSON.stringify(params)
|
||||||
|
})
|
||||||
|
.then(response => response.json())
|
||||||
|
.then(response => result_block.innerText = response.result)
|
||||||
|
.catch(error => result_block.innerText = "Playground Communication: " + error.message);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Syntax highlighting Configuration
|
||||||
|
hljs.configure({
|
||||||
|
tabReplace: ' ', // 4 spaces
|
||||||
|
languages: [], // Languages used for auto-detection
|
||||||
|
});
|
||||||
|
|
||||||
|
let code_nodes = Array
|
||||||
|
.from(document.querySelectorAll('code'))
|
||||||
|
// Don't highlight `inline code` blocks in headers.
|
||||||
|
.filter(function (node) {return !node.parentElement.classList.contains("header"); });
|
||||||
|
|
||||||
|
if (window.ace) {
|
||||||
|
// language-rust class needs to be removed for editable
|
||||||
|
// blocks or highlightjs will capture events
|
||||||
|
Array
|
||||||
|
.from(document.querySelectorAll('code.editable'))
|
||||||
|
.forEach(function (block) { block.classList.remove('language-rust'); });
|
||||||
|
|
||||||
|
Array
|
||||||
|
.from(document.querySelectorAll('code:not(.editable)'))
|
||||||
|
.forEach(function (block) { hljs.highlightBlock(block); });
|
||||||
|
} else {
|
||||||
|
code_nodes.forEach(function (block) { hljs.highlightBlock(block); });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Adding the hljs class gives code blocks the color css
|
||||||
|
// even if highlighting doesn't apply
|
||||||
|
code_nodes.forEach(function (block) { block.classList.add('hljs'); });
|
||||||
|
|
||||||
|
Array.from(document.querySelectorAll("code.language-rust")).forEach(function (block) {
|
||||||
|
|
||||||
|
var lines = Array.from(block.querySelectorAll('.boring'));
|
||||||
|
// If no lines were hidden, return
|
||||||
|
if (!lines.length) { return; }
|
||||||
|
block.classList.add("hide-boring");
|
||||||
|
|
||||||
|
var buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
buttons.innerHTML = "<button class=\"fa fa-eye\" title=\"Show hidden lines\" aria-label=\"Show hidden lines\"></button>";
|
||||||
|
|
||||||
|
// add expand button
|
||||||
|
var pre_block = block.parentNode;
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
|
||||||
|
pre_block.querySelector('.buttons').addEventListener('click', function (e) {
|
||||||
|
if (e.target.classList.contains('fa-eye')) {
|
||||||
|
e.target.classList.remove('fa-eye');
|
||||||
|
e.target.classList.add('fa-eye-slash');
|
||||||
|
e.target.title = 'Hide lines';
|
||||||
|
e.target.setAttribute('aria-label', e.target.title);
|
||||||
|
|
||||||
|
block.classList.remove('hide-boring');
|
||||||
|
} else if (e.target.classList.contains('fa-eye-slash')) {
|
||||||
|
e.target.classList.remove('fa-eye-slash');
|
||||||
|
e.target.classList.add('fa-eye');
|
||||||
|
e.target.title = 'Show hidden lines';
|
||||||
|
e.target.setAttribute('aria-label', e.target.title);
|
||||||
|
|
||||||
|
block.classList.add('hide-boring');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
if (window.playground_copyable) {
|
||||||
|
Array.from(document.querySelectorAll('pre code')).forEach(function (block) {
|
||||||
|
var pre_block = block.parentNode;
|
||||||
|
if (!pre_block.classList.contains('playground')) {
|
||||||
|
var buttons = pre_block.querySelector(".buttons");
|
||||||
|
if (!buttons) {
|
||||||
|
buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
var clipButton = document.createElement('button');
|
||||||
|
clipButton.className = 'fa fa-copy clip-button';
|
||||||
|
clipButton.title = 'Copy to clipboard';
|
||||||
|
clipButton.setAttribute('aria-label', clipButton.title);
|
||||||
|
clipButton.innerHTML = '<i class=\"tooltiptext\"></i>';
|
||||||
|
|
||||||
|
buttons.insertBefore(clipButton, buttons.firstChild);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Process playground code blocks
|
||||||
|
Array.from(document.querySelectorAll(".playground")).forEach(function (pre_block) {
|
||||||
|
// Add play button
|
||||||
|
var buttons = pre_block.querySelector(".buttons");
|
||||||
|
if (!buttons) {
|
||||||
|
buttons = document.createElement('div');
|
||||||
|
buttons.className = 'buttons';
|
||||||
|
pre_block.insertBefore(buttons, pre_block.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
var runCodeButton = document.createElement('button');
|
||||||
|
runCodeButton.className = 'fa fa-play play-button';
|
||||||
|
runCodeButton.hidden = true;
|
||||||
|
runCodeButton.title = 'Run this code';
|
||||||
|
runCodeButton.setAttribute('aria-label', runCodeButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(runCodeButton, buttons.firstChild);
|
||||||
|
runCodeButton.addEventListener('click', function (e) {
|
||||||
|
run_rust_code(pre_block);
|
||||||
|
});
|
||||||
|
|
||||||
|
if (window.playground_copyable) {
|
||||||
|
var copyCodeClipboardButton = document.createElement('button');
|
||||||
|
copyCodeClipboardButton.className = 'fa fa-copy clip-button';
|
||||||
|
copyCodeClipboardButton.innerHTML = '<i class="tooltiptext"></i>';
|
||||||
|
copyCodeClipboardButton.title = 'Copy to clipboard';
|
||||||
|
copyCodeClipboardButton.setAttribute('aria-label', copyCodeClipboardButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(copyCodeClipboardButton, buttons.firstChild);
|
||||||
|
}
|
||||||
|
|
||||||
|
let code_block = pre_block.querySelector("code");
|
||||||
|
if (window.ace && code_block.classList.contains("editable")) {
|
||||||
|
var undoChangesButton = document.createElement('button');
|
||||||
|
undoChangesButton.className = 'fa fa-history reset-button';
|
||||||
|
undoChangesButton.title = 'Undo changes';
|
||||||
|
undoChangesButton.setAttribute('aria-label', undoChangesButton.title);
|
||||||
|
|
||||||
|
buttons.insertBefore(undoChangesButton, buttons.firstChild);
|
||||||
|
|
||||||
|
undoChangesButton.addEventListener('click', function () {
|
||||||
|
let editor = window.ace.edit(code_block);
|
||||||
|
editor.setValue(editor.originalCode);
|
||||||
|
editor.clearSelection();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function themes() {
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var themeToggleButton = document.getElementById('theme-toggle');
|
||||||
|
var themePopup = document.getElementById('theme-list');
|
||||||
|
var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
|
||||||
|
var stylesheets = {
|
||||||
|
ayuHighlight: document.querySelector("[href$='ayu-highlight.css']"),
|
||||||
|
tomorrowNight: document.querySelector("[href$='tomorrow-night.css']"),
|
||||||
|
highlight: document.querySelector("[href$='highlight.css']"),
|
||||||
|
};
|
||||||
|
|
||||||
|
function showThemes() {
|
||||||
|
themePopup.style.display = 'block';
|
||||||
|
themeToggleButton.setAttribute('aria-expanded', true);
|
||||||
|
themePopup.querySelector("button#" + get_theme()).focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
function hideThemes() {
|
||||||
|
themePopup.style.display = 'none';
|
||||||
|
themeToggleButton.setAttribute('aria-expanded', false);
|
||||||
|
themeToggleButton.focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_theme() {
|
||||||
|
var theme;
|
||||||
|
try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
|
||||||
|
if (theme === null || theme === undefined) {
|
||||||
|
return default_theme;
|
||||||
|
} else {
|
||||||
|
return theme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function set_theme(theme, store = true) {
|
||||||
|
let ace_theme;
|
||||||
|
|
||||||
|
if (theme == 'coal' || theme == 'navy') {
|
||||||
|
stylesheets.ayuHighlight.disabled = true;
|
||||||
|
stylesheets.tomorrowNight.disabled = false;
|
||||||
|
stylesheets.highlight.disabled = true;
|
||||||
|
|
||||||
|
ace_theme = "ace/theme/tomorrow_night";
|
||||||
|
} else if (theme == 'ayu') {
|
||||||
|
stylesheets.ayuHighlight.disabled = false;
|
||||||
|
stylesheets.tomorrowNight.disabled = true;
|
||||||
|
stylesheets.highlight.disabled = true;
|
||||||
|
ace_theme = "ace/theme/tomorrow_night";
|
||||||
|
} else {
|
||||||
|
stylesheets.ayuHighlight.disabled = true;
|
||||||
|
stylesheets.tomorrowNight.disabled = true;
|
||||||
|
stylesheets.highlight.disabled = false;
|
||||||
|
ace_theme = "ace/theme/dawn";
|
||||||
|
}
|
||||||
|
|
||||||
|
setTimeout(function () {
|
||||||
|
themeColorMetaTag.content = getComputedStyle(document.body).backgroundColor;
|
||||||
|
}, 1);
|
||||||
|
|
||||||
|
if (window.ace && window.editors) {
|
||||||
|
window.editors.forEach(function (editor) {
|
||||||
|
editor.setTheme(ace_theme);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
var previousTheme = get_theme();
|
||||||
|
|
||||||
|
if (store) {
|
||||||
|
try { localStorage.setItem('mdbook-theme', theme); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
html.classList.remove(previousTheme);
|
||||||
|
html.classList.add(theme);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set theme
|
||||||
|
var theme = get_theme();
|
||||||
|
|
||||||
|
set_theme(theme, false);
|
||||||
|
|
||||||
|
themeToggleButton.addEventListener('click', function () {
|
||||||
|
if (themePopup.style.display === 'block') {
|
||||||
|
hideThemes();
|
||||||
|
} else {
|
||||||
|
showThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
themePopup.addEventListener('click', function (e) {
|
||||||
|
var theme = e.target.id || e.target.parentElement.id;
|
||||||
|
set_theme(theme);
|
||||||
|
});
|
||||||
|
|
||||||
|
themePopup.addEventListener('focusout', function(e) {
|
||||||
|
// e.relatedTarget is null in Safari and Firefox on macOS (see workaround below)
|
||||||
|
if (!!e.relatedTarget && !themeToggleButton.contains(e.relatedTarget) && !themePopup.contains(e.relatedTarget)) {
|
||||||
|
hideThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
|
||||||
|
document.addEventListener('click', function(e) {
|
||||||
|
if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
|
||||||
|
hideThemes();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
document.addEventListener('keydown', function (e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
|
||||||
|
if (!themePopup.contains(e.target)) { return; }
|
||||||
|
|
||||||
|
switch (e.key) {
|
||||||
|
case 'Escape':
|
||||||
|
e.preventDefault();
|
||||||
|
hideThemes();
|
||||||
|
break;
|
||||||
|
case 'ArrowUp':
|
||||||
|
e.preventDefault();
|
||||||
|
var li = document.activeElement.parentElement;
|
||||||
|
if (li && li.previousElementSibling) {
|
||||||
|
li.previousElementSibling.querySelector('button').focus();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'ArrowDown':
|
||||||
|
e.preventDefault();
|
||||||
|
var li = document.activeElement.parentElement;
|
||||||
|
if (li && li.nextElementSibling) {
|
||||||
|
li.nextElementSibling.querySelector('button').focus();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'Home':
|
||||||
|
e.preventDefault();
|
||||||
|
themePopup.querySelector('li:first-child button').focus();
|
||||||
|
break;
|
||||||
|
case 'End':
|
||||||
|
e.preventDefault();
|
||||||
|
themePopup.querySelector('li:last-child button').focus();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function sidebar() {
|
||||||
|
var html = document.querySelector("html");
|
||||||
|
var sidebar = document.getElementById("sidebar");
|
||||||
|
var sidebarLinks = document.querySelectorAll('#sidebar a');
|
||||||
|
var sidebarToggleButton = document.getElementById("sidebar-toggle");
|
||||||
|
var sidebarResizeHandle = document.getElementById("sidebar-resize-handle");
|
||||||
|
var firstContact = null;
|
||||||
|
|
||||||
|
function showSidebar() {
|
||||||
|
html.classList.remove('sidebar-hidden')
|
||||||
|
html.classList.add('sidebar-visible');
|
||||||
|
Array.from(sidebarLinks).forEach(function (link) {
|
||||||
|
link.setAttribute('tabIndex', 0);
|
||||||
|
});
|
||||||
|
sidebarToggleButton.setAttribute('aria-expanded', true);
|
||||||
|
sidebar.setAttribute('aria-hidden', false);
|
||||||
|
try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
|
||||||
|
|
||||||
|
function toggleSection(ev) {
|
||||||
|
ev.currentTarget.parentElement.classList.toggle('expanded');
|
||||||
|
}
|
||||||
|
|
||||||
|
Array.from(sidebarAnchorToggles).forEach(function (el) {
|
||||||
|
el.addEventListener('click', toggleSection);
|
||||||
|
});
|
||||||
|
|
||||||
|
function hideSidebar() {
|
||||||
|
html.classList.remove('sidebar-visible')
|
||||||
|
html.classList.add('sidebar-hidden');
|
||||||
|
Array.from(sidebarLinks).forEach(function (link) {
|
||||||
|
link.setAttribute('tabIndex', -1);
|
||||||
|
});
|
||||||
|
sidebarToggleButton.setAttribute('aria-expanded', false);
|
||||||
|
sidebar.setAttribute('aria-hidden', true);
|
||||||
|
try { localStorage.setItem('mdbook-sidebar', 'hidden'); } catch (e) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
// Toggle sidebar
|
||||||
|
sidebarToggleButton.addEventListener('click', function sidebarToggle() {
|
||||||
|
if (html.classList.contains("sidebar-hidden")) {
|
||||||
|
var current_width = parseInt(
|
||||||
|
document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
|
||||||
|
if (current_width < 150) {
|
||||||
|
document.documentElement.style.setProperty('--sidebar-width', '150px');
|
||||||
|
}
|
||||||
|
showSidebar();
|
||||||
|
} else if (html.classList.contains("sidebar-visible")) {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
if (getComputedStyle(sidebar)['transform'] === 'none') {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
showSidebar();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
sidebarResizeHandle.addEventListener('mousedown', initResize, false);
|
||||||
|
|
||||||
|
function initResize(e) {
|
||||||
|
window.addEventListener('mousemove', resize, false);
|
||||||
|
window.addEventListener('mouseup', stopResize, false);
|
||||||
|
html.classList.add('sidebar-resizing');
|
||||||
|
}
|
||||||
|
function resize(e) {
|
||||||
|
var pos = (e.clientX - sidebar.offsetLeft);
|
||||||
|
if (pos < 20) {
|
||||||
|
hideSidebar();
|
||||||
|
} else {
|
||||||
|
if (html.classList.contains("sidebar-hidden")) {
|
||||||
|
showSidebar();
|
||||||
|
}
|
||||||
|
pos = Math.min(pos, window.innerWidth - 100);
|
||||||
|
document.documentElement.style.setProperty('--sidebar-width', pos + 'px');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//on mouseup remove windows functions mousemove & mouseup
|
||||||
|
function stopResize(e) {
|
||||||
|
html.classList.remove('sidebar-resizing');
|
||||||
|
window.removeEventListener('mousemove', resize, false);
|
||||||
|
window.removeEventListener('mouseup', stopResize, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
document.addEventListener('touchstart', function (e) {
|
||||||
|
firstContact = {
|
||||||
|
x: e.touches[0].clientX,
|
||||||
|
time: Date.now()
|
||||||
|
};
|
||||||
|
}, { passive: true });
|
||||||
|
|
||||||
|
document.addEventListener('touchmove', function (e) {
|
||||||
|
if (!firstContact)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var curX = e.touches[0].clientX;
|
||||||
|
var xDiff = curX - firstContact.x,
|
||||||
|
tDiff = Date.now() - firstContact.time;
|
||||||
|
|
||||||
|
if (tDiff < 250 && Math.abs(xDiff) >= 150) {
|
||||||
|
if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
|
||||||
|
showSidebar();
|
||||||
|
else if (xDiff < 0 && curX < 300)
|
||||||
|
hideSidebar();
|
||||||
|
|
||||||
|
firstContact = null;
|
||||||
|
}
|
||||||
|
}, { passive: true });
|
||||||
|
|
||||||
|
// Scroll sidebar to current active section
|
||||||
|
var activeSection = document.getElementById("sidebar").querySelector(".active");
|
||||||
|
if (activeSection) {
|
||||||
|
// https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
|
||||||
|
activeSection.scrollIntoView({ block: 'center' });
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function chapterNavigation() {
|
||||||
|
document.addEventListener('keydown', function (e) {
|
||||||
|
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
|
||||||
|
if (window.search && window.search.hasFocus()) { return; }
|
||||||
|
|
||||||
|
switch (e.key) {
|
||||||
|
case 'ArrowRight':
|
||||||
|
e.preventDefault();
|
||||||
|
var nextButton = document.querySelector('.nav-chapters.next');
|
||||||
|
if (nextButton) {
|
||||||
|
window.location.href = nextButton.href;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'ArrowLeft':
|
||||||
|
e.preventDefault();
|
||||||
|
var previousButton = document.querySelector('.nav-chapters.previous');
|
||||||
|
if (previousButton) {
|
||||||
|
window.location.href = previousButton.href;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function clipboard() {
|
||||||
|
var clipButtons = document.querySelectorAll('.clip-button');
|
||||||
|
|
||||||
|
function hideTooltip(elem) {
|
||||||
|
elem.firstChild.innerText = "";
|
||||||
|
elem.className = 'fa fa-copy clip-button';
|
||||||
|
}
|
||||||
|
|
||||||
|
function showTooltip(elem, msg) {
|
||||||
|
elem.firstChild.innerText = msg;
|
||||||
|
elem.className = 'fa fa-copy tooltipped';
|
||||||
|
}
|
||||||
|
|
||||||
|
var clipboardSnippets = new ClipboardJS('.clip-button', {
|
||||||
|
text: function (trigger) {
|
||||||
|
hideTooltip(trigger);
|
||||||
|
let playground = trigger.closest("pre");
|
||||||
|
return playground_text(playground);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
Array.from(clipButtons).forEach(function (clipButton) {
|
||||||
|
clipButton.addEventListener('mouseout', function (e) {
|
||||||
|
hideTooltip(e.currentTarget);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
clipboardSnippets.on('success', function (e) {
|
||||||
|
e.clearSelection();
|
||||||
|
showTooltip(e.trigger, "Copied!");
|
||||||
|
});
|
||||||
|
|
||||||
|
clipboardSnippets.on('error', function (e) {
|
||||||
|
showTooltip(e.trigger, "Clipboard error!");
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function scrollToTop () {
|
||||||
|
var menuTitle = document.querySelector('.menu-title');
|
||||||
|
|
||||||
|
menuTitle.addEventListener('click', function () {
|
||||||
|
document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
(function controllMenu() {
|
||||||
|
var menu = document.getElementById('menu-bar');
|
||||||
|
|
||||||
|
(function controllPosition() {
|
||||||
|
var scrollTop = document.scrollingElement.scrollTop;
|
||||||
|
var prevScrollTop = scrollTop;
|
||||||
|
var minMenuY = -menu.clientHeight - 50;
|
||||||
|
// When the script loads, the page can be at any scroll (e.g. if you reforesh it).
|
||||||
|
menu.style.top = scrollTop + 'px';
|
||||||
|
// Same as parseInt(menu.style.top.slice(0, -2), but faster
|
||||||
|
var topCache = menu.style.top.slice(0, -2);
|
||||||
|
menu.classList.remove('sticky');
|
||||||
|
var stickyCache = false; // Same as menu.classList.contains('sticky'), but faster
|
||||||
|
document.addEventListener('scroll', function () {
|
||||||
|
scrollTop = Math.max(document.scrollingElement.scrollTop, 0);
|
||||||
|
// `null` means that it doesn't need to be updated
|
||||||
|
var nextSticky = null;
|
||||||
|
var nextTop = null;
|
||||||
|
var scrollDown = scrollTop > prevScrollTop;
|
||||||
|
var menuPosAbsoluteY = topCache - scrollTop;
|
||||||
|
if (scrollDown) {
|
||||||
|
nextSticky = false;
|
||||||
|
if (menuPosAbsoluteY > 0) {
|
||||||
|
nextTop = prevScrollTop;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (menuPosAbsoluteY > 0) {
|
||||||
|
nextSticky = true;
|
||||||
|
} else if (menuPosAbsoluteY < minMenuY) {
|
||||||
|
nextTop = prevScrollTop + minMenuY;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (nextSticky === true && stickyCache === false) {
|
||||||
|
menu.classList.add('sticky');
|
||||||
|
stickyCache = true;
|
||||||
|
} else if (nextSticky === false && stickyCache === true) {
|
||||||
|
menu.classList.remove('sticky');
|
||||||
|
stickyCache = false;
|
||||||
|
}
|
||||||
|
if (nextTop !== null) {
|
||||||
|
menu.style.top = nextTop + 'px';
|
||||||
|
topCache = nextTop;
|
||||||
|
}
|
||||||
|
prevScrollTop = scrollTop;
|
||||||
|
}, { passive: true });
|
||||||
|
})();
|
||||||
|
(function controllBorder() {
|
||||||
|
menu.classList.remove('bordered');
|
||||||
|
document.addEventListener('scroll', function () {
|
||||||
|
if (menu.offsetTop === 0) {
|
||||||
|
menu.classList.remove('bordered');
|
||||||
|
} else {
|
||||||
|
menu.classList.add('bordered');
|
||||||
|
}
|
||||||
|
}, { passive: true });
|
||||||
|
})();
|
||||||
|
})();
|
||||||
7
0.3.0/clipboard.min.js
vendored
Normal file
7
0.3.0/clipboard.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
351
0.3.0/cmake.html
Normal file
351
0.3.0/cmake.html
Normal file
|
|
@ -0,0 +1,351 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>cmake - Rules ForeignCc</title>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="cmake.html" class="active"><strong aria-hidden="true">1.1.</strong> cmake</a></li><li class="chapter-item expanded "><a href="configure_make.html"><strong aria-hidden="true">1.2.</strong> configure_make</a></li><li class="chapter-item expanded "><a href="make.html"><strong aria-hidden="true">1.3.</strong> make</a></li><li class="chapter-item expanded "><a href="ninja.html"><strong aria-hidden="true">1.4.</strong> ninja</a></li><li class="chapter-item expanded "><a href="flatten.html"><strong aria-hidden="true">1.5.</strong> Full API</a></li></ol></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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>
|
||||||
|
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||||||
|
<h1 id="cmake"><a class="header" href="#cmake">CMake</a></h1>
|
||||||
|
<h2 id="building-cmake-projects"><a class="header" href="#building-cmake-projects">Building CMake projects</a></h2>
|
||||||
|
<ul>
|
||||||
|
<li>Build libraries/binaries with CMake from sources using cmake rule</li>
|
||||||
|
<li>Use cmake targets in <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library">cc_library</a>, <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary">cc_binary</a> targets as dependency</li>
|
||||||
|
<li>Bazel <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_toolchain">cc_toolchain</a> parameters are used inside cmake build</li>
|
||||||
|
<li>See full list of cmake arguments below 'example'</li>
|
||||||
|
<li>cmake is defined in <code>./tools/build_defs</code></li>
|
||||||
|
<li>Works on Ubuntu, Mac OS and Windows(* see special notes below in Windows section) operating systems</li>
|
||||||
|
</ul>
|
||||||
|
<p><strong>Example:</strong>
|
||||||
|
(Please see full examples in ./examples)</p>
|
||||||
|
<p>The example for <strong>Windows</strong> is below, in the section 'Usage on Windows'.</p>
|
||||||
|
<ul>
|
||||||
|
<li>In <code>WORKSPACE.bazel</code>, we use a <code>http_archive</code> to download tarballs with the libraries we use.</li>
|
||||||
|
<li>In <code>BUILD.bazel</code>, we instantiate a <code>cmake</code> rule which behaves similarly to a <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library">cc_library</a>, which can then be used in a C++ rule (<a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary">cc_binary</a> in this case).</li>
|
||||||
|
</ul>
|
||||||
|
<p>In <code>WORKSPACE.bazel</code>, put</p>
|
||||||
|
<pre><code class="language-python">workspace(name = "rules_foreign_cc_usage_example")
|
||||||
|
|
||||||
|
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
|
||||||
|
|
||||||
|
# Rule repository, note that it's recommended to use a pinned commit to a released version of the rules
|
||||||
|
http_archive(
|
||||||
|
name = "rules_foreign_cc",
|
||||||
|
sha256 = "c2cdcf55ffaf49366725639e45dedd449b8c3fe22b54e31625eb80ce3a240f1e",
|
||||||
|
strip_prefix = "rules_foreign_cc-0.1.0",
|
||||||
|
url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.1.0.zip",
|
||||||
|
)
|
||||||
|
|
||||||
|
load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies")
|
||||||
|
|
||||||
|
# This sets up some common toolchains for building targets. For more details, please see
|
||||||
|
# https://github.com/bazelbuild/rules_foreign_cc/tree/main/docs#rules_foreign_cc_dependencies
|
||||||
|
rules_foreign_cc_dependencies()
|
||||||
|
|
||||||
|
_ALL_CONTENT = """\
|
||||||
|
filegroup(
|
||||||
|
name = "all_srcs",
|
||||||
|
srcs = glob(["**"]),
|
||||||
|
visibility = ["//visibility:public"],
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
# pcre source code repository
|
||||||
|
http_archive(
|
||||||
|
name = "pcre",
|
||||||
|
build_file_content = _ALL_CONTENT,
|
||||||
|
strip_prefix = "pcre-8.43",
|
||||||
|
urls = [
|
||||||
|
"https://mirror.bazel.build/ftp.pcre.org/pub/pcre/pcre-8.43.tar.gz",
|
||||||
|
"https://ftp.pcre.org/pub/pcre/pcre-8.43.tar.gz",
|
||||||
|
],
|
||||||
|
sha256 = "0b8e7465dc5e98c757cc3650a20a7843ee4c3edf50aaf60bb33fd879690d2c73",
|
||||||
|
)
|
||||||
|
</code></pre>
|
||||||
|
<p>And in the <code>BUILD.bazel</code> file, put:</p>
|
||||||
|
<pre><code class="language-python">load("@rules_foreign_cc//foreign_cc:defs.bzl", "cmake")
|
||||||
|
|
||||||
|
cmake(
|
||||||
|
name = "pcre",
|
||||||
|
cache_entries = {
|
||||||
|
"CMAKE_C_FLAGS": "-fPIC",
|
||||||
|
},
|
||||||
|
lib_source = "@pcre//:all_srcs",
|
||||||
|
out_static_libs = ["libpcre.a"],
|
||||||
|
)
|
||||||
|
</code></pre>
|
||||||
|
<p>then build as usual:</p>
|
||||||
|
<pre><code class="language-bash">bazel build //:pcre
|
||||||
|
</code></pre>
|
||||||
|
<p><strong>Usage on Windows</strong></p>
|
||||||
|
<p>When using on Windows, you should start Bazel in MSYS2 shell, as the shell script inside cmake assumes this.
|
||||||
|
Also, you should explicitly specify <strong>make commands and option to generate CMake crosstool file</strong>.</p>
|
||||||
|
<p>The default generator for CMake will be detected automatically, or you can specify it explicitly.</p>
|
||||||
|
<p><strong>The tested generators:</strong> Visual Studio 15, Ninja and NMake.
|
||||||
|
The extension <code>.lib</code> is assumed for the static libraries by default.</p>
|
||||||
|
<p>Example usage (see full example in <code>./examples/cmake_hello_world_lib</code>):
|
||||||
|
Example assumes that MS Visual Studio and Ninja are installed on the host machine, and Ninja bin directory is added to PATH.</p>
|
||||||
|
<pre><code class="language-python">cmake(
|
||||||
|
# expect to find ./lib/hello.lib as the result of the build
|
||||||
|
name = "hello",
|
||||||
|
# This option can be omitted
|
||||||
|
generate_args = [
|
||||||
|
"-G \"Visual Studio 15 2017\"",
|
||||||
|
"-A Win64",
|
||||||
|
],
|
||||||
|
lib_source = ":srcs",
|
||||||
|
)
|
||||||
|
|
||||||
|
cmake(
|
||||||
|
name = "hello_ninja",
|
||||||
|
# expect to find ./lib/hello.lib as the result of the build
|
||||||
|
lib_name = "hello",
|
||||||
|
# explicitly specify the generator
|
||||||
|
generate_args = ["-GNinja"],
|
||||||
|
lib_source = ":srcs",
|
||||||
|
)
|
||||||
|
|
||||||
|
cmake(
|
||||||
|
name = "hello_nmake",
|
||||||
|
# explicitly specify the generator
|
||||||
|
generate_args = ["-G \"NMake Makefiles\""],
|
||||||
|
lib_source = ":srcs",
|
||||||
|
# expect to find ./lib/hello.lib as the result of the build
|
||||||
|
out_static_libs = ["hello.lib"],
|
||||||
|
)
|
||||||
|
</code></pre>
|
||||||
|
<p><a id="#cmake"></a></p>
|
||||||
|
<h2 id="cmake-1"><a class="header" href="#cmake-1">cmake</a></h2>
|
||||||
|
<pre>
|
||||||
|
cmake(<a href="#cmake-name">name</a>, <a href="#cmake-additional_inputs">additional_inputs</a>, <a href="#cmake-additional_tools">additional_tools</a>, <a href="#cmake-alwayslink">alwayslink</a>, <a href="#cmake-build_args">build_args</a>, <a href="#cmake-cache_entries">cache_entries</a>, <a href="#cmake-data">data</a>,
|
||||||
|
<a href="#cmake-defines">defines</a>, <a href="#cmake-deps">deps</a>, <a href="#cmake-env">env</a>, <a href="#cmake-env_vars">env_vars</a>, <a href="#cmake-generate_args">generate_args</a>, <a href="#cmake-generate_crosstool_file">generate_crosstool_file</a>, <a href="#cmake-install">install</a>, <a href="#cmake-install_args">install_args</a>,
|
||||||
|
<a href="#cmake-lib_name">lib_name</a>, <a href="#cmake-lib_source">lib_source</a>, <a href="#cmake-linkopts">linkopts</a>, <a href="#cmake-out_bin_dir">out_bin_dir</a>, <a href="#cmake-out_binaries">out_binaries</a>, <a href="#cmake-out_headers_only">out_headers_only</a>, <a href="#cmake-out_include_dir">out_include_dir</a>,
|
||||||
|
<a href="#cmake-out_interface_libs">out_interface_libs</a>, <a href="#cmake-out_lib_dir">out_lib_dir</a>, <a href="#cmake-out_shared_libs">out_shared_libs</a>, <a href="#cmake-out_static_libs">out_static_libs</a>, <a href="#cmake-postfix_script">postfix_script</a>, <a href="#cmake-targets">targets</a>,
|
||||||
|
<a href="#cmake-tools_deps">tools_deps</a>, <a href="#cmake-working_directory">working_directory</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external library with CMake.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="cmake-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-build_args"></a>build_args</td><td align="left">Arguments for the CMake build command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-cache_entries"></a>cache_entries</td><td align="left">CMake cache entries to initialize (they will be passed with <code>-Dkey=value</code>) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-env_vars"></a>env_vars</td><td align="left">CMake environment variable values to join with toolchain-defined. For example, additional <code>CXXFLAGS</code>.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-generate_args"></a>generate_args</td><td align="left">Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: <code>["-G Ninja", "--debug-output", "-DFOO=bar"]</code>. Note that unless a generator (<code>-G</code>) argument is provided, the default generators are <a href="https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html">Unix Makefiles</a> for Linux and MacOS and <a href="https://cmake.org/cmake/help/latest/generator/Ninja.html">Ninja</a> for Windows.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-generate_crosstool_file"></a>generate_crosstool_file</td><td align="left">When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as <code>-Dkey=value</code> and environment variables). If <code>CMAKE_TOOLCHAIN_FILE</code> cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify <code>CMAKE_SYSTEM_NAME</code> in the cache_entries</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install"></a>install</td><td align="left">If True, the <code>cmake --install</code> comand will be performed after a build</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-install_args"></a>install_args</td><td align="left">Arguments for the CMake install command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="cmake-working_directory"></a>working_directory</td><td align="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
<a rel="prev" href="index.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="configure_make.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="index.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="configure_make.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 type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
256
0.3.0/configure_make.html
Normal file
256
0.3.0/configure_make.html
Normal file
|
|
@ -0,0 +1,256 @@
|
||||||
|
<!DOCTYPE HTML>
|
||||||
|
<html lang="en" class="sidebar-visible no-js light">
|
||||||
|
<head>
|
||||||
|
<!-- Book generated using mdBook -->
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>configure_make - Rules ForeignCc</title>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Custom HTML head -->
|
||||||
|
|
||||||
|
|
||||||
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||||||
|
<meta name="description" content="">
|
||||||
|
<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>
|
||||||
|
<!-- Provide site root to javascript -->
|
||||||
|
<script type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
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 type="text/javascript">
|
||||||
|
var html = document.querySelector('html');
|
||||||
|
var sidebar = 'hidden';
|
||||||
|
if (document.body.clientWidth >= 1080) {
|
||||||
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||||||
|
sidebar = sidebar || 'visible';
|
||||||
|
}
|
||||||
|
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="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="cmake.html"><strong aria-hidden="true">1.1.</strong> cmake</a></li><li class="chapter-item expanded "><a href="configure_make.html" class="active"><strong aria-hidden="true">1.2.</strong> configure_make</a></li><li class="chapter-item expanded "><a href="make.html"><strong aria-hidden="true">1.3.</strong> make</a></li><li class="chapter-item expanded "><a href="ninja.html"><strong aria-hidden="true">1.4.</strong> ninja</a></li><li class="chapter-item expanded "><a href="flatten.html"><strong aria-hidden="true">1.5.</strong> Full API</a></li></ol></li></ol> </div>
|
||||||
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<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 bordered">
|
||||||
|
<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 (default)</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">Rules ForeignCc</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/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||||||
|
<i id="git-repository-button" class="fa fa-github"></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 type="text/javascript">
|
||||||
|
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>
|
||||||
|
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||||||
|
<p>A rule for building projects using the[Configure+Make][cm] build tool
|
||||||
|
[cm]: https://www.gnu.org/prep/standards/html_node/Configuration.html</p>
|
||||||
|
<p><a id="#configure_make"></a></p>
|
||||||
|
<h2 id="configure_make"><a class="header" href="#configure_make">configure_make</a></h2>
|
||||||
|
<pre>
|
||||||
|
configure_make(<a href="#configure_make-name">name</a>, <a href="#configure_make-additional_inputs">additional_inputs</a>, <a href="#configure_make-additional_tools">additional_tools</a>, <a href="#configure_make-alwayslink">alwayslink</a>, <a href="#configure_make-args">args</a>, <a href="#configure_make-autoconf">autoconf</a>,
|
||||||
|
<a href="#configure_make-autoconf_env_vars">autoconf_env_vars</a>, <a href="#configure_make-autoconf_options">autoconf_options</a>, <a href="#configure_make-autogen">autogen</a>, <a href="#configure_make-autogen_command">autogen_command</a>, <a href="#configure_make-autogen_env_vars">autogen_env_vars</a>,
|
||||||
|
<a href="#configure_make-autogen_options">autogen_options</a>, <a href="#configure_make-autoreconf">autoreconf</a>, <a href="#configure_make-autoreconf_env_vars">autoreconf_env_vars</a>, <a href="#configure_make-autoreconf_options">autoreconf_options</a>,
|
||||||
|
<a href="#configure_make-configure_command">configure_command</a>, <a href="#configure_make-configure_env_vars">configure_env_vars</a>, <a href="#configure_make-configure_in_place">configure_in_place</a>, <a href="#configure_make-configure_options">configure_options</a>, <a href="#configure_make-data">data</a>,
|
||||||
|
<a href="#configure_make-defines">defines</a>, <a href="#configure_make-deps">deps</a>, <a href="#configure_make-env">env</a>, <a href="#configure_make-install_prefix">install_prefix</a>, <a href="#configure_make-lib_name">lib_name</a>, <a href="#configure_make-lib_source">lib_source</a>, <a href="#configure_make-linkopts">linkopts</a>, <a href="#configure_make-make_commands">make_commands</a>,
|
||||||
|
<a href="#configure_make-out_bin_dir">out_bin_dir</a>, <a href="#configure_make-out_binaries">out_binaries</a>, <a href="#configure_make-out_headers_only">out_headers_only</a>, <a href="#configure_make-out_include_dir">out_include_dir</a>, <a href="#configure_make-out_interface_libs">out_interface_libs</a>,
|
||||||
|
<a href="#configure_make-out_lib_dir">out_lib_dir</a>, <a href="#configure_make-out_shared_libs">out_shared_libs</a>, <a href="#configure_make-out_static_libs">out_static_libs</a>, <a href="#configure_make-postfix_script">postfix_script</a>, <a href="#configure_make-targets">targets</a>, <a href="#configure_make-tools_deps">tools_deps</a>)
|
||||||
|
</pre>
|
||||||
|
<p>Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.</p>
|
||||||
|
<p><strong>ATTRIBUTES</strong></p>
|
||||||
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||||||
|
<tr><td align="left"><a id="configure_make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_inputs"></a>additional_inputs</td><td align="left">Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-additional_tools"></a>additional_tools</td><td align="left">Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf"></a>autoconf</td><td align="left">Set to True if 'autoconf' should be invoked before 'configure', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_env_vars"></a>autoconf_env_vars</td><td align="left">Environment variables to be set for 'autoconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoconf_options"></a>autoconf_options</td><td align="left">Any options to be put in the 'autoconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen"></a>autogen</td><td align="left">Set to True if 'autogen.sh' should be invoked before 'configure', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_command"></a>autogen_command</td><td align="left">The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.</td><td align="left">String</td><td align="left">optional</td><td align="left">"autogen.sh"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_env_vars"></a>autogen_env_vars</td><td align="left">Environment variables to be set for 'autogen' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autogen_options"></a>autogen_options</td><td align="left">Any options to be put in the 'autogen.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf"></a>autoreconf</td><td align="left">Set to True if 'autoreconf' should be invoked before 'configure.', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_env_vars"></a>autoreconf_env_vars</td><td align="left">Environment variables to be set for 'autoreconf' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-autoreconf_options"></a>autoreconf_options</td><td align="left">Any options to be put in the 'autoreconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_command"></a>configure_command</td><td align="left">The name of the configuration script file, default: configure. The file must be in the root of the source directory.</td><td align="left">String</td><td align="left">optional</td><td align="left">"configure"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_env_vars"></a>configure_env_vars</td><td align="left">Environment variables to be set for the 'configure' invocation.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_in_place"></a>configure_in_place</td><td align="left">Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-configure_options"></a>configure_options</td><td align="left">Any options to be put on the 'configure' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-make_commands"></a>make_commands</td><td align="left">Optional make commands.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["make", "make install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||||||
|
<tr><td align="left"><a id="configure_make-tools_deps"></a>tools_deps</td><td align="left">Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||||
|
<!-- Mobile navigation buttons -->
|
||||||
|
<a rel="prev" href="cmake.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="make.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="cmake.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="make.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 type="text/javascript">
|
||||||
|
window.playground_copyable = true;
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||||||
|
|
||||||
|
<!-- Custom JS scripts -->
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
495
0.3.0/css/chrome.css
Normal file
495
0.3.0/css/chrome.css
Normal file
|
|
@ -0,0 +1,495 @@
|
||||||
|
/* CSS for UI elements (a.k.a. chrome) */
|
||||||
|
|
||||||
|
@import 'variables.css';
|
||||||
|
|
||||||
|
::-webkit-scrollbar {
|
||||||
|
background: var(--bg);
|
||||||
|
}
|
||||||
|
::-webkit-scrollbar-thumb {
|
||||||
|
background: var(--scrollbar);
|
||||||
|
}
|
||||||
|
html {
|
||||||
|
scrollbar-color: var(--scrollbar) var(--bg);
|
||||||
|
}
|
||||||
|
#searchresults a,
|
||||||
|
.content a:link,
|
||||||
|
a:visited,
|
||||||
|
a > .hljs {
|
||||||
|
color: var(--links);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Menu Bar */
|
||||||
|
|
||||||
|
#menu-bar,
|
||||||
|
#menu-bar-hover-placeholder {
|
||||||
|
z-index: 101;
|
||||||
|
margin: auto calc(0px - var(--page-padding));
|
||||||
|
}
|
||||||
|
#menu-bar {
|
||||||
|
position: relative;
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
background-color: var(--bg);
|
||||||
|
border-bottom-color: var(--bg);
|
||||||
|
border-bottom-width: 1px;
|
||||||
|
border-bottom-style: solid;
|
||||||
|
}
|
||||||
|
#menu-bar.sticky,
|
||||||
|
.js #menu-bar-hover-placeholder:hover + #menu-bar,
|
||||||
|
.js #menu-bar:hover,
|
||||||
|
.js.sidebar-visible #menu-bar {
|
||||||
|
position: -webkit-sticky;
|
||||||
|
position: sticky;
|
||||||
|
top: 0 !important;
|
||||||
|
}
|
||||||
|
#menu-bar-hover-placeholder {
|
||||||
|
position: sticky;
|
||||||
|
position: -webkit-sticky;
|
||||||
|
top: 0;
|
||||||
|
height: var(--menu-bar-height);
|
||||||
|
}
|
||||||
|
#menu-bar.bordered {
|
||||||
|
border-bottom-color: var(--table-border-color);
|
||||||
|
}
|
||||||
|
#menu-bar i, #menu-bar .icon-button {
|
||||||
|
position: relative;
|
||||||
|
padding: 0 8px;
|
||||||
|
z-index: 10;
|
||||||
|
line-height: var(--menu-bar-height);
|
||||||
|
cursor: pointer;
|
||||||
|
transition: color 0.5s;
|
||||||
|
}
|
||||||
|
@media only screen and (max-width: 420px) {
|
||||||
|
#menu-bar i, #menu-bar .icon-button {
|
||||||
|
padding: 0 5px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon-button {
|
||||||
|
border: none;
|
||||||
|
background: none;
|
||||||
|
padding: 0;
|
||||||
|
color: inherit;
|
||||||
|
}
|
||||||
|
.icon-button i {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.right-buttons {
|
||||||
|
margin: 0 15px;
|
||||||
|
}
|
||||||
|
.right-buttons a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left-buttons {
|
||||||
|
display: flex;
|
||||||
|
margin: 0 5px;
|
||||||
|
}
|
||||||
|
.no-js .left-buttons {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-title {
|
||||||
|
display: inline-block;
|
||||||
|
font-weight: 200;
|
||||||
|
font-size: 2.4rem;
|
||||||
|
line-height: var(--menu-bar-height);
|
||||||
|
text-align: center;
|
||||||
|
margin: 0;
|
||||||
|
flex: 1;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
.js .menu-title {
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-bar,
|
||||||
|
.menu-bar:visited,
|
||||||
|
.nav-chapters,
|
||||||
|
.nav-chapters:visited,
|
||||||
|
.mobile-nav-chapters,
|
||||||
|
.mobile-nav-chapters:visited,
|
||||||
|
.menu-bar .icon-button,
|
||||||
|
.menu-bar a i {
|
||||||
|
color: var(--icons);
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-bar i:hover,
|
||||||
|
.menu-bar .icon-button:hover,
|
||||||
|
.nav-chapters:hover,
|
||||||
|
.mobile-nav-chapters i:hover {
|
||||||
|
color: var(--icons-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Nav Icons */
|
||||||
|
|
||||||
|
.nav-chapters {
|
||||||
|
font-size: 2.5em;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
margin: 0;
|
||||||
|
max-width: 150px;
|
||||||
|
min-width: 90px;
|
||||||
|
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
align-content: center;
|
||||||
|
flex-direction: column;
|
||||||
|
|
||||||
|
transition: color 0.5s, background-color 0.5s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-chapters:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
background-color: var(--theme-hover);
|
||||||
|
transition: background-color 0.15s, color 0.15s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-wrapper {
|
||||||
|
margin-top: 50px;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mobile-nav-chapters {
|
||||||
|
font-size: 2.5em;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
width: 90px;
|
||||||
|
border-radius: 5px;
|
||||||
|
background-color: var(--sidebar-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.previous {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.next {
|
||||||
|
float: right;
|
||||||
|
right: var(--page-padding);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media only screen and (max-width: 1080px) {
|
||||||
|
.nav-wide-wrapper { display: none; }
|
||||||
|
.nav-wrapper { display: block; }
|
||||||
|
}
|
||||||
|
|
||||||
|
@media only screen and (max-width: 1380px) {
|
||||||
|
.sidebar-visible .nav-wide-wrapper { display: none; }
|
||||||
|
.sidebar-visible .nav-wrapper { display: block; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Inline code */
|
||||||
|
|
||||||
|
:not(pre) > .hljs {
|
||||||
|
display: inline;
|
||||||
|
padding: 0.1em 0.3em;
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
:not(pre):not(a) > .hljs {
|
||||||
|
color: var(--inline-code-color);
|
||||||
|
overflow-x: initial;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover > .hljs {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
pre > .buttons {
|
||||||
|
position: absolute;
|
||||||
|
z-index: 100;
|
||||||
|
right: 5px;
|
||||||
|
top: 5px;
|
||||||
|
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
pre > .buttons :hover {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
pre > .buttons i {
|
||||||
|
margin-left: 8px;
|
||||||
|
}
|
||||||
|
pre > .buttons button {
|
||||||
|
color: inherit;
|
||||||
|
background: transparent;
|
||||||
|
border: none;
|
||||||
|
cursor: inherit;
|
||||||
|
}
|
||||||
|
pre > .result {
|
||||||
|
margin-top: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Search */
|
||||||
|
|
||||||
|
#searchresults a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
mark {
|
||||||
|
border-radius: 2px;
|
||||||
|
padding: 0 3px 1px 3px;
|
||||||
|
margin: 0 -3px -1px -3px;
|
||||||
|
background-color: var(--search-mark-bg);
|
||||||
|
transition: background-color 300ms linear;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
mark.fade-out {
|
||||||
|
background-color: rgba(0,0,0,0) !important;
|
||||||
|
cursor: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchbar-outer {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
}
|
||||||
|
|
||||||
|
#searchbar {
|
||||||
|
width: 100%;
|
||||||
|
margin: 5px auto 0px auto;
|
||||||
|
padding: 10px 16px;
|
||||||
|
transition: box-shadow 300ms ease-in-out;
|
||||||
|
border: 1px solid var(--searchbar-border-color);
|
||||||
|
border-radius: 3px;
|
||||||
|
background-color: var(--searchbar-bg);
|
||||||
|
color: var(--searchbar-fg);
|
||||||
|
}
|
||||||
|
#searchbar:focus,
|
||||||
|
#searchbar.active {
|
||||||
|
box-shadow: 0 0 3px var(--searchbar-shadow-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchresults-header {
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 1em;
|
||||||
|
padding: 18px 0 0 5px;
|
||||||
|
color: var(--searchresults-header-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchresults-outer {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
max-width: var(--content-max-width);
|
||||||
|
border-bottom: 1px dashed var(--searchresults-border-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
ul#searchresults {
|
||||||
|
list-style: none;
|
||||||
|
padding-left: 20px;
|
||||||
|
}
|
||||||
|
ul#searchresults li {
|
||||||
|
margin: 10px 0px;
|
||||||
|
padding: 2px;
|
||||||
|
border-radius: 2px;
|
||||||
|
}
|
||||||
|
ul#searchresults li.focus {
|
||||||
|
background-color: var(--searchresults-li-bg);
|
||||||
|
}
|
||||||
|
ul#searchresults span.teaser {
|
||||||
|
display: block;
|
||||||
|
clear: both;
|
||||||
|
margin: 5px 0 0 20px;
|
||||||
|
font-size: 0.8em;
|
||||||
|
}
|
||||||
|
ul#searchresults span.teaser em {
|
||||||
|
font-weight: bold;
|
||||||
|
font-style: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Sidebar */
|
||||||
|
|
||||||
|
.sidebar {
|
||||||
|
position: fixed;
|
||||||
|
left: 0;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
width: var(--sidebar-width);
|
||||||
|
font-size: 0.875em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
-webkit-overflow-scrolling: touch;
|
||||||
|
overscroll-behavior-y: contain;
|
||||||
|
background-color: var(--sidebar-bg);
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
}
|
||||||
|
.sidebar-resizing {
|
||||||
|
-moz-user-select: none;
|
||||||
|
-webkit-user-select: none;
|
||||||
|
-ms-user-select: none;
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
.js:not(.sidebar-resizing) .sidebar {
|
||||||
|
transition: transform 0.3s; /* Animation: slide away */
|
||||||
|
}
|
||||||
|
.sidebar code {
|
||||||
|
line-height: 2em;
|
||||||
|
}
|
||||||
|
.sidebar .sidebar-scrollbox {
|
||||||
|
overflow-y: auto;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
left: 0;
|
||||||
|
right: 0;
|
||||||
|
padding: 10px 10px;
|
||||||
|
}
|
||||||
|
.sidebar .sidebar-resize-handle {
|
||||||
|
position: absolute;
|
||||||
|
cursor: col-resize;
|
||||||
|
width: 0;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
}
|
||||||
|
.js .sidebar .sidebar-resize-handle {
|
||||||
|
cursor: col-resize;
|
||||||
|
width: 5px;
|
||||||
|
}
|
||||||
|
.sidebar-hidden .sidebar {
|
||||||
|
transform: translateX(calc(0px - var(--sidebar-width)));
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar {
|
||||||
|
background: var(--sidebar-bg);
|
||||||
|
}
|
||||||
|
.sidebar::-webkit-scrollbar-thumb {
|
||||||
|
background: var(--scrollbar);
|
||||||
|
}
|
||||||
|
|
||||||
|
.sidebar-visible .page-wrapper {
|
||||||
|
transform: translateX(var(--sidebar-width));
|
||||||
|
}
|
||||||
|
@media only screen and (min-width: 620px) {
|
||||||
|
.sidebar-visible .page-wrapper {
|
||||||
|
transform: none;
|
||||||
|
margin-left: var(--sidebar-width);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter {
|
||||||
|
list-style: none outside none;
|
||||||
|
padding-left: 0;
|
||||||
|
line-height: 2.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter ol {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li {
|
||||||
|
display: flex;
|
||||||
|
color: var(--sidebar-non-existant);
|
||||||
|
}
|
||||||
|
.chapter li a {
|
||||||
|
display: block;
|
||||||
|
padding: 0;
|
||||||
|
text-decoration: none;
|
||||||
|
color: var(--sidebar-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li a:hover {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li a.active {
|
||||||
|
color: var(--sidebar-active);
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li > a.toggle {
|
||||||
|
cursor: pointer;
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
padding: 0 10px;
|
||||||
|
user-select: none;
|
||||||
|
opacity: 0.68;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li > a.toggle div {
|
||||||
|
transition: transform 0.5s;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* collapse the section */
|
||||||
|
.chapter li:not(.expanded) + li > ol {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.chapter-item {
|
||||||
|
line-height: 1.5em;
|
||||||
|
margin-top: 0.6em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.chapter li.expanded > a.toggle div {
|
||||||
|
transform: rotate(90deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.spacer {
|
||||||
|
width: 100%;
|
||||||
|
height: 3px;
|
||||||
|
margin: 5px 0px;
|
||||||
|
}
|
||||||
|
.chapter .spacer {
|
||||||
|
background-color: var(--sidebar-spacer);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (-moz-touch-enabled: 1), (pointer: coarse) {
|
||||||
|
.chapter li a { padding: 5px 0; }
|
||||||
|
.spacer { margin: 10px 0; }
|
||||||
|
}
|
||||||
|
|
||||||
|
.section {
|
||||||
|
list-style: none outside none;
|
||||||
|
padding-left: 20px;
|
||||||
|
line-height: 1.9em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Theme Menu Popup */
|
||||||
|
|
||||||
|
.theme-popup {
|
||||||
|
position: absolute;
|
||||||
|
left: 10px;
|
||||||
|
top: var(--menu-bar-height);
|
||||||
|
z-index: 1000;
|
||||||
|
border-radius: 4px;
|
||||||
|
font-size: 0.7em;
|
||||||
|
color: var(--fg);
|
||||||
|
background: var(--theme-popup-bg);
|
||||||
|
border: 1px solid var(--theme-popup-border);
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.theme-popup .default {
|
||||||
|
color: var(--icons);
|
||||||
|
}
|
||||||
|
.theme-popup .theme {
|
||||||
|
width: 100%;
|
||||||
|
border: 0;
|
||||||
|
margin: 0;
|
||||||
|
padding: 2px 10px;
|
||||||
|
line-height: 25px;
|
||||||
|
white-space: nowrap;
|
||||||
|
text-align: left;
|
||||||
|
cursor: pointer;
|
||||||
|
color: inherit;
|
||||||
|
background: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
.theme-popup .theme:hover {
|
||||||
|
background-color: var(--theme-hover);
|
||||||
|
}
|
||||||
|
.theme-popup .theme:hover:first-child,
|
||||||
|
.theme-popup .theme:hover:last-child {
|
||||||
|
border-top-left-radius: inherit;
|
||||||
|
border-top-right-radius: inherit;
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue