mirror of
https://github.com/mroi/apple-internals.git
synced 2026-02-12 17:12:44 +00:00
add HTML-based web viewer
This commit is contained in:
Michael Roitzsch
21
LICENSE.txt
Normal file
21
LICENSE.txt
Normal file
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2020 Michael Roitzsch
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
@@ -2,7 +2,8 @@ Apple Internals
|
||||
===============
|
||||
|
||||
This repository provides tools and information to help understand and analyze the internals
|
||||
of Apple’s operating system platforms. Specifically, a [Nix
|
||||
of Apple’s operating system platforms. Information is collected in a text file and
|
||||
[presented on a website](https://mroi.github.io/apple-internals). A [Nix
|
||||
flake](https://github.com/tweag/rfcs/blob/flakes/rfcs/0049-flakes.md) allows to build the
|
||||
following externally hosted tools:
|
||||
|
||||
@@ -11,3 +12,7 @@ Unpacks asset catalogs to individual files.
|
||||
|
||||
[**snapUtil**](https://github.com/ahl/apfs)
|
||||
Manages APFS snapshots.
|
||||
|
||||
___
|
||||
This work is licensed under the [MIT license](https://mit-license.org) so you can freely use
|
||||
and share as long as you retain the copyright notice and license text.
|
||||
|
||||
113
index.html
Normal file
113
index.html
Normal file
@@ -0,0 +1,113 @@
|
||||
<!DOCTYPE html>
|
||||
<meta charset="utf-8">
|
||||
<title>Apple Internals</title>
|
||||
<script>
|
||||
|
||||
// generate HTML markup from plain text internals document
|
||||
class Converter {
|
||||
constructor(text) {
|
||||
this.text = text;
|
||||
this.filter = "";
|
||||
}
|
||||
generate() {
|
||||
const dl = document.createElement("dl");
|
||||
dl.setAttribute("class", "row");
|
||||
for (const rowText of this.text.split("\n"))
|
||||
if (rowText.length && rowText.toLowerCase().includes(this.filter.toLowerCase()))
|
||||
dl.append.apply(dl, this.generateRow(rowText));
|
||||
return dl;
|
||||
}
|
||||
generateRow(text) {
|
||||
let result = new Array();
|
||||
const parts = text.split("\t");
|
||||
result.push(this.generateTerm(parts[0]));
|
||||
result.push(this.generateDefinition(parts.slice(1).join("; ")));
|
||||
return result;
|
||||
}
|
||||
generateTerm(text) {
|
||||
const dt = document.createElement("dt");
|
||||
dt.setAttribute("class", "col-sm-2");
|
||||
dt.append.apply(dt, this.highlight(text));
|
||||
return dt;
|
||||
}
|
||||
generateDefinition(text) {
|
||||
const dd = document.createElement("dd");
|
||||
dd.setAttribute("class", "col-sm-10");
|
||||
dd.append.apply(dd, this.highlight(text));
|
||||
return dd;
|
||||
}
|
||||
highlight(text) {
|
||||
if (!this.filter.length) return Array(text);
|
||||
let result = new Array();
|
||||
let index = 0;
|
||||
while (index = text.toLowerCase().indexOf(this.filter.toLowerCase()), index >= 0) {
|
||||
result.push(text.substr(0, index));
|
||||
const mark = document.createElement("mark");
|
||||
mark.append(text.substr(index, this.filter.length));
|
||||
result.push(mark);
|
||||
text = text.substr(index + this.filter.length);
|
||||
}
|
||||
result.push(text);
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
document.addEventListener("DOMContentLoaded", event => {
|
||||
// load main content
|
||||
fetch("internals.txt").then(function(response) {
|
||||
if (!response.ok) return "";
|
||||
return response.text();
|
||||
}).then(function(text) {
|
||||
const converter = new Converter(text);
|
||||
const update = filter => {
|
||||
converter.filter = filter;
|
||||
const content = document.getElementById("content");
|
||||
while (content.firstChild) content.firstChild.remove();
|
||||
content.append(converter.generate());
|
||||
};
|
||||
// update content when typing a filter word
|
||||
document.getElementById("filter").addEventListener("input", event => {
|
||||
update(event.target.value.length >= 3 ? event.target.value : "");
|
||||
});
|
||||
// select filter text on return
|
||||
document.getElementById("filter").addEventListener("change", event => {
|
||||
event.target.select();
|
||||
});
|
||||
// clear filter button
|
||||
document.getElementById("clear").addEventListener("click", event => {
|
||||
document.getElementById("filter").value = "";
|
||||
document.getElementById("filter").focus();
|
||||
update("");
|
||||
});
|
||||
// initialize filter control
|
||||
document.getElementById("clear").click();
|
||||
});
|
||||
});
|
||||
</script>
|
||||
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/5.0.0-alpha2/css/bootstrap.min.css" integrity="sha384-DhY6onE6f3zzKbjUPRc2hOzGAdEf4/Dz+WJwBvEYL/lkkIsI3ihufq9hk9K4lVoK" crossorigin="anonymous">
|
||||
<style type="text/css">
|
||||
body {
|
||||
font-size: 90%;
|
||||
}
|
||||
mark {
|
||||
position: relative;
|
||||
z-index: -1;
|
||||
padding: .2em;
|
||||
margin: -.2em;
|
||||
}
|
||||
</style>
|
||||
<body class="container-fluid p-4">
|
||||
<h1 class="mb-3">Apple Internals</h1>
|
||||
<p class="my-0">Collected knowledge about the internals of Apple’s platforms.</p>
|
||||
<p class="my-0">Sorted by keyword, abbreviation, or codename.</p>
|
||||
<p>Feel free to contribute on <a href="https://github.com/mroi/apple-internals">GitHub</a> or share under <a href="https://github.com/mroi/apple-internals/blob/main/LICENSE.txt">MIT license</a>.</p>
|
||||
<div class="input-group" style="max-width:30em">
|
||||
<input id="filter" type="text" class="form-control" placeholder="Filter">
|
||||
<div id="clear" class="input-group-text">
|
||||
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-x-circle-fill" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zM5.354 4.646a.5.5 0 1 0-.708.708L7.293 8l-2.647 2.646a.5.5 0 0 0 .708.708L8 8.707l2.646 2.647a.5.5 0 0 0 .708-.708L8.707 8l2.647-2.646a.5.5 0 0 0-.708-.708L8 7.293 5.354 4.646z"/>
|
||||
</svg>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content" class="mt-3">
|
||||
</body>
|
||||
Reference in New Issue
Block a user