build index.html for all winners

Updated manifest as per recent file changes.

Updated winner `.winner.json` to reflect the manifest changes.

Added [bin/all_run.sh](bin/all_run.sh) tool to run a command over
all winning entries.

These tools had slight improvements in the help usage message:

* bin/gen-author.sh VERSION="1.3.1 2024-01-16"
* bin/gen-inventory.sh VERSION="1.0.1 2024-01-16"
* bin/pandoc_wrapper.sh VERSION="1.3.1 2024-01-16"
* bin/subst.default.sh VERSION="1.1.1 2024-01-16"
* bin/subst.winner-index.sh VERSION="1.1.1 2024-01-16"

The `bin/readme2index.sh` tool was improved so that
if the `index.html` file exists and the tool forms
the exact same content, then the file `index.html`
file is NOT touched.

* bin/readme2index.sh VERSION="1.1 2024-01-16"

We used the following command to generate `index.html` files
for all winning entries:

```sh
bin/all_run.sh -v 3 bin/readme2index.sh
```

NOTE: We have not (yet) built HTML files above the winner directory
level (e.g., no year level nor top level HTML), nor have be built
non-index HTML files for winners.

NOTE: By default we are running `pandoc(1)` with:

```
--fail-if-warnings=true
```

This means that any problems with markdown to HTML
generates an error.  This is done to be sure that
the HTML conversion is clean.

We had to fix the following `README.md` files:

* `2000/rince/README.md`

The reference [^2] was never used.  We made a guess that [^2] applies
to the same spot as [^1].  Perhaps there is a better spot where
[^2] applies?

NOTE: For every reference, there MUST be some place where that
reference is used.

* 2012/vik/README.md

The string "$...$" is assumed to be a TeX encoded string.

NOTE: Every "$..$" needs to be backslashed as in "\$..\$".

* 2018/burton1/README.md

The reference [2] was duplicated.  We changed the
second [2] to [3].

NOTE: Every reference needs to have a unique number.

* 2020/carlini/README.md

The string "$...$" is assumed to be a TeX encoded string.

NOTE: Every "$..$" needs to be backslashed as in "\$..\$".

We also found 2 errors in the `author/author_handle.json` file set:

* author/Anonymous_2001.json

The `author/Anonymous_2001.json` file was missing.

* author/Jari_Arkko.json

The winner ID for `1989_jar.1` had a typo.
This commit is contained in:
Landon Curt Noll committed 2024-01-17 00:32:39 -08:00
1 parent 893cd915b6
commit c1466f5165
350 files changed
+95242 -4217

No files matched your search

+308 -13
View File
@@ -1,4 +1,6 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- START: two lines up starts content from: inc/top.default.html -->
<!-- -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
@@ -6,27 +8,320 @@
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- -->
<!-- file: 2020/giles/index.html created by: fake.gen_index.sh version: 1.0.5 2023-10-31 -->
<html lang="en">
<!-- END: this line ends content from: inc/top.default.html -->
<!-- -->
<!-- This file was formed by the tool: bin/readme2index.sh version: 1.1 2024-01-16 -->
<!-- -->
<!-- START: this line starts content from: inc/head.default.html -->
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>2020 giles</title>
<meta name="description" content="IOCCC year: 2020 IOCCC winner: giles winner index page">
<meta name="keywords" content="IOCCC,2020,giles,winner index page">
<link rel="stylesheet" href="/temp-test-ioccc/ioccc.css">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>2020/giles</title>
<meta name="description" content="2020 IOCCC winner giles">
<meta name="keywords" content="IOCCC, 2020, IOCCC 2020, IOCCC winner, giles">
</head>
<!-- END: this line ends content from: inc/head.default.html -->
<!-- START: this line starts content from: inc/body.default.html -->
<body>
<h1>2020 giles</h1>
<!-- END: this line ends content from: inc/body.default.html -->
<!-- START: this line starts content from: inc/header.default.html -->
<p>XXX - fake content until readme2index is working - XXX</p>
<div class="header">
<img src="/temp-test-ioccc/png/ioccc.png" alt="IOCCC image by Matt Zucker" width=300 height=110>
<h1>The International Obfuscated C Code Contest</h1>
<h2>2020/giles</h2>
</div>
<hr style="width:50%;text-align:left;margin-left:0">
<!-- END: this line ends content from: inc/header.default.html -->
<!-- START: this line starts content from: inc/topnav.mid.html -->
<!-- Start Nu Html Checker -->
<p><a href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fioccc-src.github.io%2Ftemp-test-ioccc%2F2020%2Fgiles%2Findex.html">Nu Html check https://ioccc-src.github.io/temp-test-ioccc/2020/giles/index.html</a></p>
<!-- End Nu Html Checker -->
<div class="topnav">
<a class="Left" href="../ferguson2/index.html">&larr; ferguson2</a>
<a class="Left" href="../index.html">&uarr; 2020 &uarr;</a>
<a class="Left" href="../kurdyukov1/index.html">kurdyukov1 &rarr;</a>
<a class="Right" href="#inventory">Inventory</a>
</div>
<!-- END: this line ends content from: inc/topnav.mid.html -->
<!-- START: this line starts content from: inc/begin-row.default.html -->
<div class="row">
<!-- END: this line ends content from: inc/begin-row.default.html -->
<!-- START: this line starts content from: inc/begin-leftcolumn.default.html -->
<div class="leftcolumn">
<!-- END: this line ends content from: inc/begin-leftcolumn.default.html -->
<!-- START: this line starts content from: inc/sidenav.default.html -->
<div class="sidenav">
<a href="#content">Jump to contents</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/index.html">IOCCC Home</a>
<a href="/temp-test-ioccc/years.html">Winning Entries</a>
<a href="/temp-test-ioccc/winners.html">People who have won</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/news.html">IOCCC News</a>
<a href="/temp-test-ioccc/faq.html#submit">How to enter the IOCCC</a>
<a href="/temp-test-ioccc/faq.html">FAQ</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/bugs.html">Bugs &amp; (mis)features</a>
<a href="/temp-test-ioccc/faq.html#fix_a_winner">Fixing IOCCC winners</a>
<a href="/temp-test-ioccc/faq.html#fix_web_site">Fixing the web site</a>
<a href="/temp-test-ioccc/faq.html#fix_author">Fixing winner info</a>
<a href="/temp-test-ioccc/thanks-for-help.html">Thanks for the help</a>
</div>
<hr>
<div class="sidenav">
<a href="/temp-test-ioccc/judges.html">The IOCCC Judges</a>
<a href="/temp-test-ioccc/contact.html">Contacting the IOCCC</a>
</div>
<hr>
<div class="sidenav">
<a href="#top">Jump to top</a>
</div>
<!-- END: this line ends content from: inc/sidenav.default.html -->
<!-- START: this line starts content from: inc/end-leftcolumn.default.html -->
</div>
<!-- END: this line ends content from: inc/end-leftcolumn.default.html -->
<!-- START: this line starts content from: inc/begin-rightcolumn.default.html -->
<div class="rightcolumn">
<!-- END: this line ends content from: inc/begin-rightcolumn.default.html -->
<!-- START: this line starts content from: inc/before-content.default.html -->
<a name="content"></a>
<!-- END: this line ends content from: inc/before-content.default.html -->
<!-- START: this line starts content generated by: bin/gen-author.sh -->
<p><a name="author"><strong>Author:</strong></a> <br><br>Name: <a
href="/temp-test-ioccc/winners.html#Edward_Giles">Edward Giles</a><br>
Location: <a href="/temp-test-ioccc/location.html#AU">AU</a></p>
<!-- END: next line ends content generated by: bin/gen-author.sh -->
<h2 id="to-build">To build:</h2>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span></span></code></pre></div>
<h3 id="bugs-and-misfeatures">Bugs and (Mis)features:</h3>
<p>The current status of this entry is:</p>
<pre><code>STATUS: INABIAF - please **DO NOT** fix</code></pre>
<p>For more detailed information see <a href="/bugs.md#2020-giles">2020
giles in bugs.md</a>.</p>
<h2 id="to-use">To use:</h2>
<div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./prog</span> <span class="op">&lt;</span> dtmf.wav</span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="ex">./prog</span> <span class="pp">[</span><span class="ss">digits</span><span class="pp">]</span> <span class="op">&gt;</span> digits.wav</span></code></pre></div>
<p>where <code>dtmf.wav</code> is a WAV file of the dialling of a number
being dialled with <a
href="https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling">DTMF
(Dual-tone multi frequency)</a> (more commonly known as Touch-Tone) and
<code>[digits]</code> is a sequence of digits that will be converted to
the DTMF sound!</p>
<h2 id="try">Try:</h2>
<div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./try.sh</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="ex">./prog</span> <span class="op">&lt;</span> pi.wav</span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="co"># See </span></span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a><span class="ex">./prog</span> 867-5309 <span class="op">&gt;</span> jenny.wav</span></code></pre></div>
<p>If the script <a href="try.sh">try.sh</a> did not play a WAV file, it
means you do not have SoX installed; see <a href="/faq.md#faq3_10">FAQ
3.10: How do I compile and use an IOCCC winner that requires
sound?</a>). In this case install it and try it again or play the files
<code>jenny.wav</code> and <code>ioccc28.wav</code> in a program that
can play WAV files.</p>
<p>NOTE: the phone number of <code>jenny.wav</code> comes from <a
href="https://en.wikipedia.org/wiki/867-5309/Jenny"
class="uri">https://en.wikipedia.org/wiki/867-5309/Jenny</a>.</p>
<h2 id="judges-remarks">Judges’ remarks:</h2>
<p>A cross platform utility for both encoding and decoding touch
tones.</p>
<h2 id="authors-remarks">Author’s remarks:</h2>
<h3 id="introduction-and-usage">Introduction and Usage</h3>
<p>This program encodes and decodes <a
href="https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling">dual-tone
multiple frequency</a> signals used in telephone systems, more commonly
known as Touch-Tones.</p>
<p>If the program is executed with no arguments, it will read a WAV file
from standard input, decode the touch-tones in the file, and output the
corresponding digits to standard output. This program only supports WAV
files that have exactly 16 bits per sample, but it allows any sample
rate and any number of audio channels.</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ./prog <span class="op">&lt;</span> pi.wav</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="ex">31415926</span></span></code></pre></div>
<p>If the program is executed with a command-line argument, it will
generate the tones corresponding to the specified characters, writing
them to standard output as a WAV file.</p>
<div class="sourceCode" id="cb6"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> ./prog 867-5309 <span class="kw">|</span> <span class="fu">aplay</span></span></code></pre></div>
<h3 id="interesting-features">Interesting Features</h3>
<ul>
<li>When compiled with <code>gcc -pedantic -Wall -Wextra</code> there
are no compiler warnings.</li>
<li>This program can be successfully compiled and run on Windows, using
both Microsoft’s C compiler and <a
href="https://bellard.org/tcc/">TCC</a>.</li>
<li>This program resamples the incoming audio, so that it can accept
audio data at any sample rate.</li>
<li>The code that generates the output sine-waves is the same as the
code that looks for sine-waves in the input. (see Algorithm Details for
roughly how this works).</li>
<li>Despite handling lots of sine waves, the program only uses basic
arithmetic operations. It does not depend on <code>libm</code>.</li>
<li>All type punning is done with <code>memcpy(3)</code> so there are no
strict-aliasing violations.</li>
<li>The size of the source code using the IOCCC size tool is 1963, the
year the first push-button telephones were made available to
customers.</li>
<li>The source code (not counting the C pre-processor) is roughly in the
shape of a telephone handset.</li>
</ul>
<h3 id="assumptions">Assumptions</h3>
<ul>
<li>Code is compiled using the C99 or C11 standard.</li>
<li><code>CHAR_BIT == 8</code>.</li>
<li>Machine is little-endian.</li>
<li><code>int16_t</code>, <code>uint16_t</code>, and
<code>uint32_t</code> exist.</li>
<li><code>int16_t</code> is 2’s-complement.</li>
<li><code>double</code> is an IEEE 754 binary64 floating-point
type.</li>
<li><code>sizeof(double) == 8</code>.</li>
</ul>
<h3 id="obfuscations">Obfuscations</h3>
<ul>
<li>DSP code is inherently somewhat difficult to understand.</li>
<li>Lots of identifier reuse. Each identifier is used for about 2.2
different tasks, on average. For example, <code>aa</code> is both a
variable and a macro for error handling, and <code>memcpy(3)</code> is
both a library function and a <code>oto</code> label.</li>
<li>Most of the identifiers are only 1 or 2 characters long, and are
unrelated to their actual function.</li>
<li>The <code>f</code> macro is used to unroll some of the loops.</li>
<li>Some numerical constants are replaced with character literals, so
the actual value is unclear.</li>
<li>All of the strings used by the program have been combined into a
single string literal.</li>
<li>Most of the values used for the actual signal-processing all reside
in one array, named <code>l</code>. This array is usually accessed at
index <code>z</code> plus a constant. Accesses of this type have been
rewritten from, e.g. <code>l[z+17]</code> to <code>17[l+z]</code>.
<code>[l+z]</code> ends up occurring quite often, so I created the macro
<code>a</code> as a shorthand.</li>
</ul>
<h3 id="algorithm-details">Algorithm Details</h3>
<p>Each tone in a DTMF signal is a combination of two frequencies. The
lower frequency determines which row the digit is in, and the higher
frequency determines the column. There are 4 possible row frequencies
and 4 possible column frequencies.</p>
<pre><code>| | **1209 Hz** | **1336 Hz** | **1477 Hz** | **1633 Hz** |
|------------|-------------|-------------|-------------|-------------|
| **697 Hz** | 1 | 2 abc | 3 def | A |
| **770 Hz** | 4 ghi | 5 jkl | 6 mno | B |
| **852 Hz** | 7 pqrs | 8 tuv | 9 wxyz | C |
| **941 Hz** | * | 0 | # | D |</code></pre>
<p>This program determines which frequencies are present in the input by
passing it through a set of 8 virtual resonators, each tuned to one of
the frequencies used for DTMF. These can be implemented using only basic
arithmetic, and they are able to ‘select’ a specific frequency from the
input sound, blocking all other frequencies from reaching the output.
The loudness of the sound output from each resonator can therefore be
used as a measure of how much of a particular frequency was present in
the input. The program then decides, over the course of one tone, which
row frequency and which column frequency were most prominent.</p>
<p>Tones are generated using those same resonators by providing <a
href="https://en.wikipedia.org/wiki/Kronecker_delta#Digital_signal_processing">an
impulse</a> as input. An impulse can be thought of as consisting of
sine-waves at all frequencies, and when it is put through one of the
resonators, the result is a single pure sine wave.</p>
<h2 id="copyright-and-cc-by-sa-4.0-license">Copyright and CC BY-SA 4.0
License:</h2>
<p>This file is Copyright (c) 2023 by Landon Curt Noll. All Rights
Reserved. You are free to share and adapt this file under the terms of
this license:</p>
<pre><code>Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)</code></pre>
<p>For more information, see:
https://creativecommons.org/licenses/by-sa/4.0/</p>
<!-- START: this line starts content generated by: bin/gen-inventory.sh -->
<h1 id="inventory-for-2020giles"><a name="inventory"></a>Inventory for
2020/giles</h1>
<h2 id="primary-files">Primary files</h2>
<ul>
<li><a href="index.html">index.html</a> - winner home page</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/giles/prog.c">prog.c</a>
- winning source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/giles/Makefile">Makefile</a>
- winner Makefile</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/giles/prog.orig.c">prog.orig.c</a>
- original source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/giles/try.sh">try.sh</a>
- how to run</li>
<li><a href="pi.wav">pi.wav</a> - touch tone for leading decimal digits
of pi</li>
<li><a href="2020_giles.tar.bz2">2020_giles.tar.bz2</a> - download
winning source</li>
</ul>
<h2 id="secondary-files">Secondary files</h2>
<ul>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/giles/.gitignore">.gitignore</a>
- list of files that should not be committed under git</li>
<li><a href=".path">.path</a> - directory path from top directory</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/giles/.winner.json">.winner.json</a>
- description of winner in JSON</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/giles/README.md">README.md</a>
- markdown source for index.html</li>
<li><a href="dtmf.bin">dtmf.bin</a> - binary support file</li>
</ul>
<!-- END: next line ends content generated by: bin/gen-inventory.sh -->
<!-- START: this line starts content from: inc/after-content.default.html -->
<!-- END: this line ends content from: inc/after-content.default.html -->
<!-- START: this line starts content from: inc/end-rightcolumn.default.html -->
</div>
<!-- END: this line ends content from: inc/end-rightcolumn.default.html -->
<!-- START: this line starts content from: inc/end-row.default.html -->
</div>
<!-- END: this line ends content from: inc/end-row.default.html -->
<!-- START: this line starts content from: inc/footer.default.html -->
<div class="footer">
<hr>
<h2>Coda</h2>
<p><a href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fioccc-src.github.io%2Ftemp-test-ioccc%2F2020%2Fgiles%2Findex.html">Nu HTML check this web page</a></p>
<p><a href="#top">Jump to top</a> <a href="#content">Jump to Content</a> <a href="#inventory">Jump to Inventory</a></p>
</div>
<!-- END: this line ends content from: inc/footer.default.html -->
<!-- START: this line starts content from: inc/bottom.default.html -->
</body>
</html>
<!-- END: this line ends content from: inc/bottom.default.html -->