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

+363 -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,375 @@
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- -->
<!-- file: 2019/duble/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>2019 duble</title>
<meta name="description" content="IOCCC year: 2019 IOCCC winner: duble winner index page">
<meta name="keywords" content="IOCCC,2019,duble,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>2019/duble</title>
<meta name="description" content="2019 IOCCC winner duble">
<meta name="keywords" content="IOCCC, 2019, IOCCC 2019, IOCCC winner, duble">
</head>
<!-- END: this line ends content from: inc/head.default.html -->
<!-- START: this line starts content from: inc/body.default.html -->
<body>
<h1>2019 duble</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>2019/duble</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%2F2019%2Fduble%2Findex.html">Nu Html check https://ioccc-src.github.io/temp-test-ioccc/2019/duble/index.html</a></p>
<!-- End Nu Html Checker -->
<div class="topnav">
<a class="Left" href="../yang/index.html">&larr; yang</a>
<a class="Left" href="../index.html">&uarr; 2019 &uarr;</a>
<a class="Left" href="../adamovsky/index.html">adamovsky &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#Etienne_Duble">Etienne Duble</a><br>
Location: <a href="/temp-test-ioccc/location.html#FR">FR</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>
<p>There is an alternate version, the original, which does not work well
in macOS. See <a href="#alternate-code">Alternate code</a> below if you
are curious.</p>
<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#2019-duble">2019
duble 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> file</span></code></pre></div>
<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">./prog</span> /tmp/drawing</span></code></pre></div>
<p>Open another window / terminal.</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">./prog</span> /tmp/drawing</span></code></pre></div>
<p>Open more terminals and repeat…</p>
<p>You might also wish to try a full screen size. For this try:</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="fu">make</span> clobber fullscreen</span></code></pre></div>
<p>Alternatively, if you want to change the size, do something like:</p>
<div class="sourceCode" id="cb7"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> clobber LINES=20 COLUMNS=20 all</span></code></pre></div>
<p>The author provided us with the following table for use:</p>
<hr />
<ul>
<li><strong>Arrow keys</strong>: move cursor.</li>
<li><code>p</code> key: enter <em>pen</em> mode (type <strong>p</strong>
again to return to the default <em>move</em> mode).</li>
<li><code>l</code> key: enter <em>line</em> mode (type
<strong>l</strong> again to validate the line and return to the
<em>move</em> mode).</li>
<li><code>c</code> key: cycle through a small set of different
<em>colors</em>.</li>
<li><code>q</code> key: quit the editor. The drawing is automatically
saved.</li>
</ul>
<p>The mode and current color is indicated at the bottom left corner of
the editor.</p>
<p>After editing the file and quitting, try:</p>
<div class="sourceCode" id="cb8"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="ex">/tmp/drawing</span></span></code></pre></div>
<p>i.e. execute the file.</p>
<hr />
<p>WARNING: if the file is deleted it might lock any session still in
use. These will have to be killed from another shell session or by
closing the terminal tab (in other words don’t do this from the
console!). If the file cannot be opened in the beginning this will also
happen. This is discussed in <a href="/bugs.md#2019-duble">2019 duble in
bugs.md</a>.</p>
<p>NOTE: this entry might leave sockets lying about in the current
working directory which you’ll have to delete manually. This is also
discussed in <a href="/bugs.md#2019-duble">2019 duble in
bugs.md</a>.</p>
<h2 id="alternate-code">Alternate code:</h2>
<p>An alternate version of this entry, <a
href="prog.alt.c">prog.alt.c</a>, is provided. This alternate code might
not work as well in macOS.</p>
<h3 id="alternate-build">Alternate build:</h3>
<div class="sourceCode" id="cb9"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> alt</span></code></pre></div>
<h3 id="alternate-use">Alternate use:</h3>
<p>Use <code>prog.alt</code> as you would <code>prog</code> above.</p>
<h2 id="judges-remarks">Judges’ remarks:</h2>
<p>After starting the program, use the cursor keys, then try some modes,
like <code>p</code> or <code>l</code> (they toggle).</p>
<h2 id="authors-remarks">Author’s remarks:</h2>
<h3 id="introduction">Introduction:</h3>
<p>This program is a <strong>graphics editor</strong>, running in the
terminal.</p>
<p>It provides <strong>collaborative</strong> features: one can join the
drawing session of someone else by just opening the same file!</p>
<h3 id="getting-started">Getting started:</h3>
<p>The program can run on Linux, FreeBSD, macOS, and in most terminals.
See section <a href="#limits-portability">Limits, Portability</a> for
more info.</p>
<p>To build, type <code>make</code> (assuming gcc) or
<code>make CC=clang</code>.</p>
<p>Then you can start the program. It expects a file path as its first
argument:</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./prog</span> /tmp/drawing</span></code></pre></div>
<p>(If not started this way, with a file, <code>prog</code> will refuse
to start.)</p>
<p>If the file does not exist, you will start with a blank drawing.</p>
<p>If someone else (or another <em>instance of yourself</em>, maybe?) is
already editing this file, you will join the session!</p>
<h3 id="edit-features">Edit features:</h3>
<ul>
<li><strong>arrow keys</strong>: move cursor.</li>
<li><code>p</code> key: enter <em>pen</em> mode (type <strong>p</strong>
again to return to the default <em>move</em> mode).</li>
<li><code>l</code> key: enter <em>line</em> mode (type
<strong>l</strong> again to validate the line and return to the
<em>move</em> mode).</li>
<li><code>c</code> key: cycle through a small set of different
<em>colors</em>.</li>
<li><code>q</code> key: quit the editor. The drawing is automatically
saved.</li>
</ul>
<p>The mode and current color is indicated at the bottom left corner of
the editor.</p>
<h3 id="bonus-features">Bonus features:</h3>
<ul>
<li>If you just want to display the content of a drawing file, you do
not need to start the editor. Just <strong>execute the drawing
file</strong>: <code>./&lt;the-file&gt;</code>. (This will fail if
someone is still editing the file, though.)</li>
<li><code>ls --color &lt;drawing-files...&gt;</code> will probably
select different colors to indicate whether a drawing file is being
edited or not. :-)</li>
</ul>
<h3 id="obfuscation">Obfuscation:</h3>
<p>You will probably have a hard time analyzing this entry, because:</p>
<ul>
<li>Analyzing a system made of several communicating programs is known
to be a complex task. (And if you think that observing a single-user
drawing session will be a good starting point, read on.)</li>
<li>Code coverage of single vs multi-user sessions is more or less the
same. :-)</li>
<li>Code coverage when using <em>move</em>, <em>pen</em> or
<em>line</em> modes is almost the same. (so, is there a Bresenham
algorithm somewhere??)</li>
<li>Some OS resource values and <code>stdlib.h</code> call results are
inferred.</li>
<li>Whenever possible, variable names are reused.</li>
<li>You might start analyzing escape code sequences right now, but
warming up your brain is actually recommended. Start with a simple
question such as: <em>in inverse video mode, will a space char show the
foreground color or background color?</em></li>
</ul>
<h3 id="a-few-more-things">A few more things:</h3>
<p>Did you notice the <code>enum</code> declaration? Could it be just an
<code>int</code> or <code>const int</code> variable, instead? (spoiler:
<a href="http://c-faq.com/ansi/constasconst.html"
class="uri">http://c-faq.com/ansi/constasconst.html</a>)</p>
<p>If your keyboard has no arrow keys, you can probably find alternate
keys by reading the source code.</p>
<h3 id="limits-portability">Limits, Portability:</h3>
<p>I tested the program on several Linux systems, on FreeBSD 12, and on
macOS (Mojave).</p>
<p>On Linux, the program uses an OS-specific detail to hide
communication artefacts, and avoids the need to remove them on exit.
Since this is Linux-specific, it was not possible on FreeBSD or macOS.
Its behavior is a little more <em>dirty</em> there.</p>
<p>The program should work on most terminals that support 8-bit colors,
inverse video mode, and movement escape codes, e.g. <code>xterm</code>,
<code>gnome-terminal</code>, <code>terminator</code>, etc.</p>
<p>Note: the drawing files <code>prog</code> generates are probably even
more portable than <code>prog</code> itself!</p>
<h3 id="drawing-area-size">Drawing area size:</h3>
<h4 id="the-drawing-area-size-is-set-at-compilation-time">The drawing
area size is set at compilation time:</h4>
<p>The default size is the one of my xterm (see top of Makefile). You
may set it to the full size of your terminal window by typing:</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> clobber fullscreen</span></code></pre></div>
<p>IMPORTANT NOTES:</p>
<ul>
<li><strong>The program compiled with a given size will fail to reload a
drawing file with a different size!</strong></li>
<li>No scrolling is implemented (sorry but that would be too much for
rule2!), so any peer reaching the session should have a terminal with
the same size or larger.</li>
</ul>
<h3 id="prog.c-vs-prog.alt.c"><a href="prog.c">prog.c</a> vs <a
href="prog.alt.c">prog.alt.c</a></h3>
<p>The file <a href="prog.alt.c">prog.alt.c</a> is the one I
submitted.</p>
<p>The judges proposed a small update: the program was using macro
<code>FD_SET</code> inside an expression, which breaks compilation on
macOS. Wrapping this macro into a function was enough to fix this
compilation issue.</p>
<p>However, that was not enough to make the program work on macOS. If
you analyse the program you will see that it heavily relies on OS
resources. And, for this first version of the program, you even needed
to increase default <code>sysctl</code> parameters to make it work on
FreeBSD (this was the purpose of file <a
href="check-os.sh">check-os.sh</a>). I tried hard to tune macOS the
same, but failed.</p>
<p>The simple fact the Judges proposed this update meant they wish it
could work on Mac. And if the judges wish something, it <strong>has
to</strong> be done. ;) So I refactored a little more the program to
reduce OS resources consumption. Or maybe not reduce consumption, but
consume them differently… And I obtained <a href="prog.c">prog.c</a>.
With this version, no need to touch <code>sysctl</code> parameters, and
it works on macOS too! I must confess it was challenging to remain below
the size limit with this little change.</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-2019duble"><a name="inventory"></a>Inventory for
2019/duble</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/2019/duble/prog.c">prog.c</a>
- winning source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2019/duble/Makefile">Makefile</a>
- winner Makefile</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2019/duble/prog.alt.c">prog.alt.c</a>
- alternative source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2019/duble/prog.orig.c">prog.orig.c</a>
- original source</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2019/duble/check-os.sh">check-os.sh</a>
- check the operating system for compatibility</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2019/duble/fullscreen.sh">fullscreen.sh</a>
- determine full screen size for make fullscreen</li>
<li><a href="2019_duble.tar.bz2">2019_duble.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/2019/duble/.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/2019/duble/.winner.json">.winner.json</a>
- description of winner in JSON</li>
<li><a
href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2019/duble/README.md">README.md</a>
- markdown source for index.html</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%2F2019%2Fduble%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 -->