diff --git a/1984/index.html b/1984/index.html new file mode 100644 index 000000000..3d51729f7 --- /dev/null +++ b/1984/index.html @@ -0,0 +1,199 @@ + + + + + + + + + + + + + + + + + + + + + +1984 - The 1st IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1984 - The 1st IOCCC

+
+ + + + +
+ In 1st year + ↑ top ↑ + 1985 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

First annual Obfuscated +C Code Contest

+

In 1984, the first contest was held. +The name of the contest was simply +“First annual Obfuscated C Code Contest”.

+

Look at the README.mdfile for the given winning entry +for information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +This year we only had remarks from two authors but which came years +later.

+

Restrictions against machine dependent code were not in the rules in 1984. The source file size restriction was +only 512 bytes. Rules and results were posted to net.lang.c and net.unix-wizards. +The contest was announced in a net.lang.c +post.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1984,2023, Landon Curt Noll. All Rights Reserved. This +work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1984 - The 1st IOCCC

+

Download IOCCC 1984 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1985/index.html b/1985/index.html new file mode 100644 index 000000000..0a8031463 --- /dev/null +++ b/1985/index.html @@ -0,0 +1,202 @@ + + + + + + + + + + + + + + + + + + + + + +1985 - The 2nd IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1985 - The 2nd IOCCC

+
+ + + + +
+ ← 1984 + ↑ top ↑ + 1986 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Second +year of the International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry +for information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

Hints against machine dependent code were added to the rules to avoid another 1984 style winner (1984/mullender). Rules and results +were posted to net.lang.c and net.unix-wizards. +Larry Bassel was invited to help in the judging. Awards were given to 5 +classes of programs since we were unable to select only the best 4.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1985,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) that you send us a note about your use.

+ + + + + + +

Winning +Entries of 1985 - The 2nd IOCCC

+

Download IOCCC 1985 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1986/index.html b/1986/index.html new file mode 100644 index 000000000..1c65a8fbd --- /dev/null +++ b/1986/index.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + + + +1986 - The 3rd IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1986 - The 3rd IOCCC

+
+ + + + +
+ ← 1985 + ↑ top ↑ + 1987 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Third +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry +for information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The rules for 1986 suggested categories due +to the success of the 1985 judging +method. The maximum size was increased from 512 to 1024 bytes. Larry +Bassel joined as the second official judge.

+

A poll was taken for the worst code for BSD +and System V +program. The Bourne +Shell (/bin/sh) won for both systems. The BSD finger +program took third place.

+

Rules and results were posted to net.lang.c and net.unix-wizards. +Micro/Systems +Journal started regular publishing of the winners. The practice of +making first announcement of the winners at the Summer USENIX BOF (Birds +of a Feather) started this year. A notice was posted to +net.announce.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1986,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1986 - The 3rd IOCCC

+

Download IOCCC 1986 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1987/index.html b/1987/index.html new file mode 100644 index 000000000..972a027d2 --- /dev/null +++ b/1987/index.html @@ -0,0 +1,212 @@ + + + + + + + + + + + + + + + + + + + + + +1987 - The 4th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1987 - The 4th IOCCC

+
+ + + + +
+ ← 1986 + ↑ top ↑ + 1988 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Fourth +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The rules for 1997 suggested even more +categories than in 1986. Hints for what to do and not to do were also +given in the rules. For example, a simple +excessive abuse of /lib/cpp was discouraged unless the +abuse was unusual. The mailboxes for the contest were moved from nsc to +amdahl. The practice of posting a preliminary set of rules for the next +year was started this year.

+

Rules and results were posted to comp.lang.c +and comp.unix.wizards with an announcement in news.announce.important. +Micro/Systems Journal published the 1987 winners. Mark +R. Horton included a version of the 1987 winners in an appendix of his C book +Portable +C Software International Edition. The first announcement of winners +at the Summer 87 USENIX was helped by a small fly that danced all over +the foils.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1987,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1987 - The 4th IOCCC

+

Download IOCCC 1987 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1988/index.html b/1988/index.html new file mode 100644 index 000000000..7062b9cee --- /dev/null +++ b/1988/index.html @@ -0,0 +1,214 @@ + + + + + + + + + + + + + + + + + + + + + +1988 - The 5th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1988 - The 5th IOCCC

+
+ + + + +
+ ← 1987 + ↑ top ↑ + 1989 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Fifth +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The maximum size of entries was raised from 1024 to 1536 bytes, +however smaller entries were encouraged. Due to the “Best Abuse of the Rules” winner of 1987, a +limit of 160 chars in the compile line was introduced.

+

This year, the Grand Prize was given to the most unusual entry and +best abuse of the C Preprocessor rather than the most well rounded +entry.

+

Rules and results were posted to comp.lang.c, +comp.sources.unix and alt.sources. The 1988 winners will be published in +the Micro/Systems +Journal.

+

Winning entries for previous years were repackaged with each year +being in its own directory. Makefiles and hints were also provided. The +package was posted to the comp.sources.unix newsgroup. They are also +available on a wide number of USENET archive sites.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1988,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1988 - The 5th IOCCC

+

Download IOCCC 1988 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1989/index.html b/1989/index.html new file mode 100644 index 000000000..3dd203df6 --- /dev/null +++ b/1989/index.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + + + +1989 - The 6th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1989 - The 6th IOCCC

+
+ + + + +
+ ← 1988 + ↑ top ↑ + 1990 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Sixth +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

Instructions for use: Run make to compile entries (it is +possible that on System V or non-Unix systems the Makefile needs to be +changed).

+

This year, the Grand Prize was given to the most useful program.

+

The “Strangest abuse of the rules” +award was given this year to stress the fact that starting in 1990, +compiling entries must result an executable regular file.

+

The Makefile always uses the portable version of the “Best self modifying program” because there +is no loss of functionality in using it. In the case of the “Best game” winner, however, some functionality +is lost in the portable version and so the Makefile uses the original +program. System V users may need to change the Makefile to use the s5 +version. See the hint files or the Makefile for details.

+

Rules and results were posted to comp.lang.c, +comp.sources.unix, and alt.sources. They have been made available on a +wide number of USENET archive sites such as uunet. The 1989 winners will +be published in the Micro/Systems +Journal.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1989,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1989 - The 6th IOCCC

+

Download IOCCC 1989 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1990/index.html b/1990/index.html new file mode 100644 index 000000000..a55f0db34 --- /dev/null +++ b/1990/index.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + + + +1990 - The 7th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1990 - The 7th IOCCC

+
+ + + + +
+ ← 1989 + ↑ top ↑ + 1991 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Seventh +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

This year, the Grand Prize won a standing ovation at USENIX.

+

The “Strangest abuse of the rules” +award was given this year to stress the fact that starting in 1991, +entries should be shell-specific.

+

This year was the first year that we accepted ANSI C entries. It was +interesting to note that the ANSI C entries were as a whole less +portable than the K&R C entries. We hope that in future contests +people will enter more obfuscated and challenging ANSI C programs.

+

We would like to thank Barbara Frezza (loving wife of Larry Bassel) +for her role as official chef of the contest. Her opinions regarding +some of the contest entries were appreciated.

+

Rules and results were posted to +comp.lang.c, comp.sources.unix, and alt.sources. They have been made +available on a wide number of USENET archive sites such as uunet.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1990,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1990 - The 7th IOCCC

+

Download IOCCC 1990 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1991/index.html b/1991/index.html new file mode 100644 index 000000000..2ee8b937d --- /dev/null +++ b/1991/index.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + + + +1991 - The 8th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1991 - The 8th IOCCC

+
+ + + + +
+ ← 1990 + ↑ top ↑ + 1992 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Eighth +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

Instructions for use: Run make to compile entries. It is +possible that on BSD or non-Unix systems the Makefile needs to be +changed.

+

This year, we did not single out an entry that was better than all of +the rest. We selected 3 entries that were, in our opinion, went beyond +all of the other entries this year:

+ +

Name and address information are separated from the actual program +prior to judging. This eliminates any chance that we would bias our +judging for/against any person or group. In the end, we are surprised as +you are to see who has won. Even so, it is worth noting that Brian +Westley has submitted a winning entry for the past 5 years!

+

A few +notes regarding possible changes to the contest:

+

We did not give awards to some traditional contest categories such as +“Best Layout” or “Worst Abuse of the Rules”. We felt that to do so would +deny awards to more deserving entries. These categories have not been +eliminated, and will likely be considered in future years.

+

A number of entries made use of the following C pre-processor +feature:

+
#define X define
+#X foo bar
+

This is not permitted under ANSI C. Some ANSI C compilers do allow +this. In the future, we do not want programs to use this feature. +Because this request was not stated in the 1991 +rules, we did not reject entries of this type. However we provided +more portable versions so that more people could compile these +programs.

+

This year we received entries that made use of the X Window System. +Since this functionality is now available on many systems, we feel that +programs that use these are now portable enough to be valid entries.

+

We may allow programs to make use of the X Window System libs and +include files, provided that they can operate with a system running at +the level of at least X11r4. Requiring the use of imake, a specific +window manager, specific display hardware, or a specific user interface +(Openl**k, M*tif, …) is likely not to be +allowed. We will provide a more detailed explanation of our viewpoint in +next year’s rules.

+

In order to encourage more ‘normal’ looking C programs, we are +considering the following change to the maximum size rule:

+
Your source, not counting any <space>, <tab>, and a <newline> character,
+and not counting any ';', '{' and '}' character followed by a <newline>
+character, must be 1536 bytes or less.  The entire source, counting all
+characters, be 4096 bytes or less.
+

Some thought has been given to adding some C++ categories, however +this is not likely to happen soon. We are waiting until C++ compilers +become common place on a wide number of systems. We also need time to +brace ourselves for what obfuscation C++ could wield!

+

Be sure to wait until the 1992 rules are posted before submitting +entries. We may fine tune the rules to reflect the some ideas above.

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
...!{sun,pacbell,uunet,pyramid}!hoptoad!judges
+judges@toad.com
+

Final Comments

+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Credits:

+

We would like to thank Barbara Frezza for her role as official chef +of the contest. Landon Noll appreciated the opportunity to serve as +assistant pizza chef. Larry Bassel was official taste tester. Yummo!

+

Copyright and License

+

Copyright (c) 1991,2023 Landon Curt Noll and Larry Bassel. All Rights +Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1991 - The 8th IOCCC

+

Download IOCCC 1991 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1992/index.html b/1992/index.html new file mode 100644 index 000000000..7cecef552 --- /dev/null +++ b/1992/index.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + + + +1992 - The 9th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1992 - The 9th IOCCC

+
+ + + + +
+ ← 1991 + ↑ top ↑ + 1993 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Ninth +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

Use make to compile entries. It is possible that on BSD +or non-Unix systems the Makefile needs to be changed. See the Makefile +for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define i.e. the -D flag). A number of +compilers had problems optimizing certain entries. Some compilers do +optimize, but the resulting program does not work. By default we have +left off -O from compile lines. You might want to add +-O back, or add it back for certain entries where +performance is important.

+

This year marked an all time high for number of entries as well as +the quality of entries. Nearly twice the usual number of entries made it +to the final judging rounds. Even when we raised the standards for +winning, we still wound up giving out a few more awards than in other +years. The new size rules size probably contributed to the overall high +quality.

+

FYI: By tradition, we do not record the count of the number entries, +nor do we give our our guess as to the number of entries received. For +folks who wonder, we can say that we consumed about 2000 pages of output +(printing between 2 and 4 normal pages per side) during the judging +process this year.

+

The new instructions for submitting entries worked well - we were +able to write scripts to unpack them and eliminate duplicates.

+

As promised last year, we accepted programs that made use of the X +libraries for the first time. We now consider ANSI C compilers to be the +“standard” version that the entries were compiled with.

+

Name and address information are separated from the actual program +prior to judging. This eliminates any chance that we would bias our +judging for/against any person or group. In the end, we are surprised as +you are to see who has won. Even so, it is worth noting that Brian +Westley has submitted a winning entry for the past 6 years!

+

A few notes regarding +future contests:

+

We did not give awards to some traditional contest categories such as +“Best Layout”. We felt that to do so would deny awards to more deserving +entries. These categories have not been eliminated. We will likely be +awarding them in future years.

+

We received a few entries whose instructions were rot13’d. While +nothing was said about this in the rules, we found that it made the +judging process a little harder, so we may request that this not be done +this in the future.

+

Some thought has been given to a separate obfuscated perl contest. +Watch comp.lang.perl for details!

+

Be sure to wait until the 1993 rules are posted before submitting +entries. We may fine tune the rules to reflect the some ideas above.

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
...!{sun,pacbell,uunet,pyramid}!hoptoad!judges
+judges@toad.com
+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is +used.

+

Final Comments

+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Credits:

+

We would like to thank Barbara Frezza for her role as official chef +of the contest. Landon Noll and Larry Bassel appreciated the opportunity +to serve as official taste testers. Yummo!

+

Copyright and License

+

Copyright (c) 1992,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1992 - The 9th IOCCC

+

Download IOCCC 1992 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1993/index.html b/1993/index.html new file mode 100644 index 000000000..c0c1a0401 --- /dev/null +++ b/1993/index.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + + + +1993 - The 10th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1993 - The 10th IOCCC

+
+ + + + +
+ ← 1992 + ↑ top ↑ + 1994 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Tenth +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

Use make to compile entries. It is possible that on BSD +or non-Unix systems the Makefile needs to be changed. See the Makefiles +and/or README.md files for details.

+

Read over the Makefile and/or README.md files for compile/build +issues. Your system may require certain changes (add or remove a +library, add or remove a #define i.e. the -D +flag).

+

Name and address information are separated from the actual program +prior to judging. This eliminates any chance that we would bias our +judging for/against any person or group.

+

This year was the first year that ANSI C was the default. Use of +classic K&R C was allowed so long as ANSI C compilers could still +compile the entry. If you do not have an ANSI C compiler, you may not be +able to compile the winners, sorry!

+

A few notes regarding +future contests:

+

Be sure to wait until the 1994 rules are posted before submitting +entries. Rules differ from year to year, sometimes in significant +ways.

+

In 1994, we will retract the guideline that discouraged the use of C +constructs such as 3["curds"]. At one time, certain ANSI +compilers did not consider such expressions to be valid ANSI C. Alert +readers noted that the current ANSI standard considered them to be +valid. We were unable to find an ANSI C compiler that flagged such +expressions as errors.

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
...!{sun,pacbell,uunet,pyramid}!hoptoad!judges
+judges@toad.com
+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is +used.

+

Final Comments

+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Credits:

+

We would like to thank Barbara Frezza for her role as official chef +of the contest. Landon Noll and Larry Bassel appreciated the opportunity +to serve as official taste testers. And as usual, the food was +excellent.

+

Copyright and License

+

Copyright (c) 1993,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1993 - The 10th IOCCC

+

Download IOCCC 1993 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1994/index.html b/1994/index.html new file mode 100644 index 000000000..2d8566ece --- /dev/null +++ b/1994/index.html @@ -0,0 +1,301 @@ + + + + + + + + + + + + + + + + + + + + + +1994 - The 11th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1994 - The 11th IOCCC

+
+ + + + +
+ ← 1993 + ↑ top ↑ + 1995 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Eleventh +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

Use make to compile entries. It is possible that on BSD +or non-Unix systems the Makefile needs to be changed. See the Makefile +for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define i.e. the -D flag).

+

Name and address information are separated from the actual program +prior to judging. This eliminates any chance that we would bias our +judging for/against any person or group.

+

This year we retracted the guideline that discouraged the use of C +constructs such as 3["curds"]. At one time, certain ANSI +compilers did not consider such expressions to be valid ANSI C. Alert +readers noted that the current ANSI standard considered them to be +valid. We were unable to find an ANSI C compiler that flagged such +expressions as errors.

+

Rule abuse was encouraged this year - two of this year’s winners +found new and interesting abuses of the rules. Next year’s rules will +change due to these (smr and dodsond2) entries’ forms of abuse.

+

Want to be an IOCCC Judge?

+

We are thinking about adding a 3rd judge to our team. A 3rd judge +would help distribute the work load as well as to allowing us to +possibly expand or reshape the contest.

+

The ideal 3rd judge would have all of the following:

+ +

Any of the following, though not required, would be a plus:

+ +

If you think this may be you, send an email before 31 Dec 1995, +to:

+
judges@toad.com     (use the Subject: 3rd judge)
+

Include in your message:

+ +

If you have any questions about the above, feel free to ask us via +email at the above address.

+

Looking for an IOCCC WWW +site

+

We would like to setup an IOCCC home page somewhere out in WWW land. +If you have a well known stable site that would be willing to give us +access to put up some IOCCC html pages, please send an email (say prior +to 31 Dec 1995) to:

+
judges@toad.com     (use the Subject: www site)
+

describing your site and any other appropriate comments. Thanks!

+

A few notes regarding +future contests

+

Due to changes in the USENIX conference calendar, the 1995 contest +will be delayed. Because there will be no Summer 1995 USENIX conference, +the 1995 IOCCC winners will be announced at the Jan 1996 USENIX +conference.

+

The 1995 contest will not open until late October 1995, and will +close sometime around the end of December 1995. The rules for the 1995 +contest have not been formed at this time and are not expected to be +ready for distribution until late October 1995.

+

Be sure to wait until the 1995 rules are posted before submitting +entries. Rules differ from year to year, sometimes in significant +ways.

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
...!{sun,pacbell,uunet,pyramid}!hoptoad!judges
+judges@toad.com
+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is used. +as well as details on how to provide fixes to any of the entries.

+

Final Comments

+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Credits

+

We would like to thank Barbara Frezza for her role as official chef +of the contest. Landon Noll and Larry Bassel appreciated the opportunity +to serve as official taste testers. And as usual, the food was +excellent. The official menu of the 1994 Obfuscated C Contest +dinner:

+

Antipasto: meats, cheeses, olives, peppers, pickles, artichokes Soup: +Cream of tomato Salad: spring mix Pasta: Linguine with wild mushrooms +and Reggiano Parmesan Seafood: Salmon in cream sauce or lobster claws +Vegetable: Zucchini Dessert: Homemade chocolate/pecan brownies, +fruit

+

Copyright and License

+

Copyright (c) 1994,2023, Landon Curt Noll and Larry Bassel. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1994 - The 11th IOCCC

+

Download IOCCC 1994 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1995/index.html b/1995/index.html new file mode 100644 index 000000000..c15c601ca --- /dev/null +++ b/1995/index.html @@ -0,0 +1,297 @@ + + + + + + + + + + + + + + + + + + + + + +1995 - The 12th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1995 - The 12th IOCCC

+
+ + + + +
+ ← 1994 + ↑ top ↑ + 1996 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twelfth +International Obfuscated C Code Contest

+

Look at the README.md file for the given winning entry for +information on how to compile and run the winning program. Look at the +winning source and try to figure how it does what it does! You may then +wish to look at the Author's remarks section for even more +details.

+

The IOCCC has an official home page, https://www.ioccc.org, which contains previous winning +entries, information about the judges, announcements and much more.

+

Use make to compile entries. It is possible that on BSD +or non-Unix systems the Makefile needs to be changed. See +the Makefile for details.

+

Read over the Makefile for compile/build issues. Your +system may require certain changes (add or remove a library, add or +remove a #define i.e. the -D flag).

+

This year Sriram +Srinivasan joined the judging.

+

The moderator of comp.unix.wizards +did not feel that the IOCCC was “wizardly” enough to be posted to +comp.unix.wizards so we will no longer post the winners to this +newsgroup - we’ll let you the reader decide for yourself the wizardry of +these entries.

+

This year there were several people who won more than once and +several previous winners as well. The +judging was done without knowledge of the names of the submitters - +multiple winners were a coincidence. Since we tend to discount entries +that are similar to previous winners, these people had to come with +original ideas to stay in the winners circle.

+

We wish to thank CAIP +at Rutgers University for the use of their machines.

+

A few notes regarding +future contests

+

Due to changes in the USENIX conference +calendar, the 1996 contest will be +delayed. Because there will be no Summer 1996 USENIX conference, the +1996 IOCCC winners will be announced at the Jan 1997 USENIX +conference.

+

The 1996 contest will not open until sometime in October 1996, and +will close sometime around the end of December 1996. The rules for the 1996 contest have not been +formed at this time and are not expected to be ready for distribution +until late September 1996.

+

Be sure to wait until the 1996 rules +are posted before submitting entries. Rules differ from year to year, +sometimes in significant ways.

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
...!{sun,pacbell,uunet,pyramid}!hoptoad!judges
+judges@toad.com
+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is +used.

+

Final Comments

+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Credits

+

We would like to thank Barbara Frezza for her role as official chef +of the contest. Landon Noll, Larry Bassel and Sriram Srinivasan +appreciated the opportunity to serve as official taste testers. And as +usual, the food was excellent. The official menus of the 1995 Obfuscated +C Contest dinners were:

+

Session One:

+

Antipasti: Crudites, olive selection, pickles, cheese selection Soup: +Homemade mushroom and green onion soup Salad: artichoke, red bell +peppers, Italian onions, cucumbers and Greek olives with mustard +vinaigrette Main Course: Pizzas, with a variety of toppings Dessert: +Chocolate torte

+

Session Two:

+

Antipasti: crudites, olives, roasted red peppers, cheese selection +Salad: Mixed greens with vinaigrette Main Course: Spaghetti with tomato +sauce containing mushrooms and black olives selection of hot and mild +Italian sausages Bread: Fresh French bread Dessert: Cookie selection, +featuring chocolate chocolate chip cookies and chocolate butter +cookies

+

Session Three

+

Antipasti: Crudites, olive selection Salad: Mixed greens with mustard +vinaigrette Main Course: Broiled salmon with lemon pepper mayonnaise, +chard, mixture of white and wild rices Bread: Cheese bread with herbs +Dessert: Chocolate cheesecake (Courtesy of Elizabeth Watson)

+

Session Four:

+

Antipasti: Crudites, olive selection, roasted red peppers, cheese +selection Bread: Sourdough Salad: Mixed spring greens with flowers, and +mustard vinaigrette Main Course: Surf and Turf–Grilled steaks of salmon +and New York steak grilled vegetables–onions, peppers, portobello +mushrooms wild rice Dessert: Chocolate mousse

+

Session Five:

+

Antipasti: Crudites, olive selection, pickles Salad: Mixed spring +greens with mustard vinaigrette Main Course: Linguini with a cream sauce +of shiitake mushrooms and smoked salmon Bread: Garlic bread Dessert: +Flour-less chocolate torte

+

Session Six:

+

Antipasti: Carrot and celery sticks with cheese spread, olive +selection, pickles Bread: Focaccia with black olives and mozzarella +cheeses Salad: Mixed spring greens with flowers and mustard vinaigrette +Soup: Homemade butternut squash soup with mushrooms Main Course: Cracked +Dungeness crab with lemon mayonnaise, broccoli, mixture of white and +brown rice Dessert: Key lime pie

+

Copyright and License

+

Copyright (c) 1995,2023, Landon Curt Noll, Larry Bassel, Sriram +Srinivasan. All Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1995 - The 12th IOCCC

+

Download IOCCC 1995 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1996/index.html b/1996/index.html new file mode 100644 index 000000000..6512b4e79 --- /dev/null +++ b/1996/index.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + + + +1996 - The 13th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1996 - The 13th IOCCC

+
+ + + + +
+ ← 1995 + ↑ top ↑ + 1998 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Thirteenth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has an official home page: https://www.ioccc.org

+

containing previous winning entries, information about the judges, +announcements and much more.

+

Use make to compile entries. It is possible that on BSD +or non-Unix systems the Makefile needs to be changed. See the Makefile +for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define i.e. the -D flag).

+

Where are Larry +Bassel and Barbara Frezza?

+

It is not true that Larry Bassel avoided the 13th IOCCC on grounds of +superstition! Larry (as well as Landon) is fond of prime numbers. Larry +is so fond of prime numbers that he decided to become a graduate student +in number theory at UC San Diego. For this reason Larry decided to sit +out this year and plans to be back next year.

+

Barbara Frezza also went to San Diego to enter into law school at the +same time. Her cooking in the role of official chef was sorely missed. +We look forward to her return to the contest next year as well.

+

Both Larry and Barbara have taken important new steps in their lives +and we wish them the best. When it is all over, Larry will be able to +produce obfuscated mathematical proofs, and Barbara will be able +deobfuscate the many legal obfuscations. :-)

+

Remarks on some of the +entries

+

This year, Jens +Schweikhardt won 3 times … a new IOCCC record. Meanwhile, Brian +Westley came up with his 8th winning entry, twice the number of the +next highest count. But with people like Schweikhardt around, this lead +could fall fast.

+

As we stated in the guidelines, the +names of the winners are as much news to us as they are to you because +we keep authorship separate from rest of the entry. Some people have it, +we guess!

+

There were a few very good entries that might have won if it were not +for the fact that they didn’t work. If you didn’t win, but think you had +a chance: test your program, fix it and submit it next year!

+

A few notes regarding +future contests

+

There will be no 1997 contest.

+

The next contest will not open until sometime in March 1998, and will +close sometime around the end of May 1998. The rules for the 1998 +contest have not been formed at this time and are not expected to be +ready for distribution until late February 1998.

+

So what happened to 1997? Well the next USENIX Technical Conference +will be held Jun 15-19, 1998 (in New Orleans, US). The 18 month span +between conferences will cause the IOCCC to skip over 1997.

+

Be sure to wait until the 1998 rules are posted before submitting +entries. Rules differ from year to year, sometimes in significant +ways.

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
judges@toad.com
+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is +used.

+

Final Comments

+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1997,2023, Landon Curt Noll and Sriram Srinivasan. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 1996 - The 13th IOCCC

+

Download IOCCC 1996 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/1998/index.html b/1998/index.html new file mode 100644 index 000000000..0a5bdbdfd --- /dev/null +++ b/1998/index.html @@ -0,0 +1,304 @@ + + + + + + + + + + + + + + + + + + + + + +1998 - The 14th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

1998 - The 14th IOCCC

+
+ + + + +
+ ← 1996 + ↑ top ↑ + 2000 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Fourteenth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has its own domain. The IOCCC has an official home page is +now: https://www.ioccc.org.

+

Use make to compile entries. It is possible that on BSD +or non-Unix systems the Makefile needs to be changed. See the Makefile +for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define i.e. the -D flag).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

New Judges

+

Larry Bassel is now a graduate student in number theory at UC San +Diego. Barbara Frezza also went to San Diego to enter into law school at +the same time. Her cooking in the role of official chef was sorely +missed. Both Larry and Barbara have taken important new steps in their +lives. We wish them the best.

+

Landon was unable to contact Sriram Srinivasan at the start of the +1998 IOCCC season. Having not heard from Sriram, Landon put out a call +for new IOCCC judges. A number of excellent people applied.

+

Landon selected Leonid A. Broukhis, a two time IOCCC winner, as a +co-judge. Landon and Leo together selected Jeremy Horn and Peter +Seebach. The four judges (https://www.ioccc.org/judges.html) together worked +thru-out the 1998 IOCCC season.

+

2023 note about judges:

+

The number of judges now is only 2, Landon Curt Noll and Leonid A. +Broukhis.

+

Remarks on some of the +entries

+

This year, Jens +Schweikhardt won 3 times … AGAIN! He is the only person who was able +to do this, let alone do it in two contests in a row. Bas de +Bakker and David Lowe +won twice this year as well.

+

As we stated in the guidelines, the +names of the winners are as much news to us as they are to you because +we keep authorship separate from rest of the entry. Some people have it, +we guess!

+

There were a few very good entries that might have won if it were not +for the fact that they didn’t work. If you didn’t win, but think you had +a chance: test your program, fix it and submit it next year!

+

This year we awarded some outstanding entries. We recommend that you +look at all of the winners. The list of winners is a bit too long to say +something about every winner. On the other hand a partial mention of a +few is in order:

+ +

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

There was no 1997 contest

+

So what happened to 1997? There was no summer USENIX Technical +Conference. The Technical Conference was held Jun 15-19, 1998 instead … +18 months later than the 1996 summer USENIX Technical Conference. In +addition we had to select some new IOCCC judges. As a result the IOCCC +skipped over 1997.

+

Final Comments

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
questions@ioccc.org
+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is +used.

+

You must include the words ‘ioccc question’ in the subject of your +email message when sending email to the judges.

+

The next IOCCC is planned to start towards the end of 1999. Watch https://www.ioccc.org

+

for news of the next contest.

+

Final Comments

+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 1999,2023, Landon Curt Noll, Jeremy Horn, Peter Seebach +and Leonid A. Broukhis. All Rights Reserved. This work is licensed under +a Creative +Commons CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International +license. If you do use this work in some form, the IOCCC judges would appreciate (but does not +require) if you were to send us a note about +your use.

+ + + + + + +

Winning +Entries of 1998 - The 14th IOCCC

+

Download IOCCC 1998 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2000/index.html b/2000/index.html new file mode 100644 index 000000000..c2688f4bf --- /dev/null +++ b/2000/index.html @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + + + +2000 - The 15th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2000 - The 15th IOCCC

+
+ + + + +
+ ← 1998 + ↑ top ↑ + 2001 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Fifteenth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

New Judge

+

The judges were unable to contact Jeremy Horn for judging the 2000 +contest.

+

As a result, Simon Cooper: http://www.sfik.com/

+

joined our team. Simon is well known for being a co-author of the 2nd +edition of the Building Internet Firewalls book.

+

Remarks on some of the +entries

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

We believe you will be impressed with this year’s winners. The Best of Show is a fine example of compact +obfuscation. But don’t ignore the shorter winners. The Best Small Program, Best Abuse of User and Most Complete Program are well worth studying +in detail.

+

The Worst Abuse of the Rules is +technically allowed by the rules. We gave it an award this year, but +don’t assume you can get away with using it next time … :-)

+

Speaking of time, be sure to check out the Astronomically Obfuscated and the Most Timely Output.

+

There was no 1999 contest

+

So what happened to 1999? Landon Curt Noll was scheduled to take a +vacation from the IOCCC this year. The remaining judges were unable to +contact Jeremy Horn, so the IOCCC stalled.

+

But thanks to Landon’s returning early from his IOCCC vacation +(Landon will take a full IOCCC vacation during some other year), Simon +Cooper joining the IOCCC judging team as well as the hard work of Peter +Seebach and Leonid A. Broukhis the judging was completed in Dec +2000.

+

It was decided that the 15th contest would be the year 2000 contest +(the year the judging completed) rather than year 1999 (the initial +scheduled start of the contest). That is why there is no 1999 +contest.

+

NOTE: The above has been mentioned in an Amici +Curiae for the DeCSS case. See BRIEF +OF AMICI CURIAE N SUPPORT OF APPELLANTS AND REVERSAL ...

+

Final Comments

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
questions@ioccc.org
+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2000,2023, Landon Curt Noll, Peter Seebach and Leonid +A. Broukhis. All Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2000 - The 15th IOCCC

+

Download IOCCC 2000 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2001/index.html b/2001/index.html new file mode 100644 index 000000000..fa77e0fae --- /dev/null +++ b/2001/index.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + + + +2001 - The 16th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2001 - The 16th IOCCC

+
+ + + + +
+ ← 2000 + ↑ top ↑ + 2004 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Sixteenth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at https://www.ioccc.org.

+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define i.e. the -D flag).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

Remarks on some of the +entries

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

We believe you will be impressed with this year’s winners. The Best of Show is a fine example of +obfuscation. But don’t ignore the other winners! There are games, +programs that speak, ones that compile code and one that might run binaries you already +have.

+

The Best/Worst Abuse of the Rules is +technically allowed by the rules. This year we +awarded it again, but don’t assume you can get away with using the same +technique next time … :-)

+

This year there were several repeat winners. This is understating the +achievement a little - one person +has won 8 times before! (Please note that judging is done completely +anonymously.)

+

Why has it +taken so long to post the winning source?

+

This is somewhat my (Simon Cooper’s) fault. I do apologize to the +IOCCC community for this! Judging does take quite a lot of time, and I +over-committed myself several times this year. Without divulging too +much, we do look at and work out what every entry does.

+

Final Comments

+

Please send us comments and suggestions what we have expressed above. +Also include anything else that you would like to see in future +contests. Send such email to:

+
questions@ioccc.org
+

IMPORTANT NOTE: The email addresses found above are +for historical purposes only, and should not be used today. See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2001,2002,2023, Landon Curt Noll, Peter Seebach and +Leonid A. Broukhis, All Rights Reserved. This work is licensed under a +Creative +Commons CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International +license. If you do use this work in some form, the IOCCC judges would appreciate (but does not +require) if you were to send us a note about +your use.

+ + + + + + +

Winning +Entries of 2001 - The 16th IOCCC

+

Download IOCCC 2001 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2004/index.html b/2004/index.html new file mode 100644 index 000000000..e90c62e38 --- /dev/null +++ b/2004/index.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + + + +2004 - The 17th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2004 - The 17th IOCCC

+
+ + + + +
+ ← 2001 + ↑ top ↑ + 2005 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Seventeenth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winner for +information on how to compile the entry and how to run the winning +program. Look at the winning source and try to figure how it does what +it does! You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at https://www.ioccc.org/.

+

Use make(1) to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be +changed. See the Makefile for details.

+

Read over the Makefile for compile/build issues. Your +system may require certain changes (add or remove a library, add or +remove a #define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead +of your local compiler.

+

Remarks on some of the +entries

+

We believe you will be impressed with this year’s winners. The Best of Show is a fine example of obfuscation. +But don’t ignore the other winners! There are games, utilities, programs +that output images and a one-liner that is incredibly compact for what +it can do.

+

The Best Abuse of the Guidelines is +technically allowed by the rules. This year we allowed it due to the +functionality of the program. This entry is one of the easiest to read! +Don’t assume you can win using similar techniques next time … :-)

+

This year a single person won +two awards! We also had repeat winners with their 6th, 4th and 2nd +winning entries this year! (Please note that judging is done completely +anonymously. Be warned that we may disqualify entries that reveal the +identity of the submitter.)

+

Remarks on some losing +entries

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2001,2004,2023, Landon Curt Noll, Peter Seebach and +Leonid A. Broukhis. All Rights Reserved. This work is licensed under a +Creative +Commons CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International +license. If you do use this work in some form, the IOCCC judges would appreciate (but does not +require) if you were to send us a note about +your use.

+ + + + + + +

Winning +Entries of 2004 - The 17th IOCCC

+

Download IOCCC 2004 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2005/index.html b/2005/index.html new file mode 100644 index 000000000..453156bd7 --- /dev/null +++ b/2005/index.html @@ -0,0 +1,278 @@ + + + + + + + + + + + + + + + + + + + + + +2005 - The 18th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2005 - The 18th IOCCC

+
+ + + + +
+ ← 2004 + ↑ top ↑ + 2006 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Eighteenth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winner for +information on how to compile the entry and how to run the winning +program. Look at the winning source and try to figure how it does what +it does! You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at https://www.ioccc.org/.

+

Use make(1) to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be +changed. See the Makefile for details.

+

This year we included most of the information included by the +submitters in the README.md files.

+

Read over the Makefile for compile/build issues. Your +system may require certain changes (add or remove a library, add or +remove a #define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead +of your local compiler.

+

Remarks on some of the +entries

+

We believe you will be impressed with this year’s winners.

+

In particular:

+ +

Remarks on some of the +losing entries

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and resubmit +them for the next IOCCC.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2005,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2005 - The 18th IOCCC

+

Download IOCCC 2005 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2006/index.html b/2006/index.html new file mode 100644 index 000000000..56810338d --- /dev/null +++ b/2006/index.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + + + +2006 - The 19th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2006 - The 19th IOCCC

+
+ + + + +
+ ← 2005 + ↑ top ↑ + 2011 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Nineteenth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at,

+
+

https://www.ioccc.org/

+
+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

This year we included most of the information included by the +submitters in the README.md files.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

Remarks on some of the +entries

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

We believe you will be impressed with this year’s winners. The Best +of Show is a fine example of (retro) obfuscation. But don’t ignore the +other winners! There are games, puzzles, puzzle solvers, simulators, +emulators, calculators and graphical and audio tools.

+

This year a single person won three awards and another two awards! +Many winners won for the first time. (Please note that judging is done +completely anonymously. Be warned that we may disqualify entries that +reveal the identity of the submitter).

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2006,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2006 - The 19th IOCCC

+

Download IOCCC 2006 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2011/index.html b/2011/index.html new file mode 100644 index 000000000..60ac63247 --- /dev/null +++ b/2011/index.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + + + +2011 - The 20th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2011 - The 20th IOCCC

+
+ + + + +
+ ← 2006 + ↑ top ↑ + 2012 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twentieth +International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at,

+
+

https://www.ioccc.org/

+
+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

This year we included most of the information included by the +submitters in the README.md files.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

Remarks on some of the +entries

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

We believe you will be impressed with this year’s winners. The Best +of Show is a fine example of character stitching. But don’t ignore the +other winners! There are games, puzzle solvers, utilities, eye candy, +calculators and graphical and audio tools.

+

This year all winners are different, and there is a winner from a new +country - China! Many winners won for the first time. (Please note that +judging is done completely anonymously. Be warned that we may disqualify +entries that reveal the identity of the submitter).

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2012,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2011 - The 20th IOCCC

+

Download IOCCC 2011 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2012/index.html b/2012/index.html new file mode 100644 index 000000000..c4ea4f902 --- /dev/null +++ b/2012/index.html @@ -0,0 +1,283 @@ + + + + + + + + + + + + + + + + + + + + + +2012 - The 21st IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2012 - The 21st IOCCC

+
+ + + + +
+ ← 2011 + ↑ top ↑ + 2013 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twenty +First International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at,

+
+

https://www.ioccc.org/

+
+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

Remarks on some of the +entries

+

We believe you will be impressed with this year’s winners. We had a +very difficult time picking a single best from among the other winners +because the overall quality of the winners were so high.

+

This year we selected the top 4 entries for particularly high +honors:

+ +

But don’t ignore the other winners! There are games, utilities, eye +candy, calculators and graphical tools to explore.

+

This year, Yusuke Endoh won with two entries, one of which (endoh1) +won the special Honorable mention award. Eight of the winning entries +were from people who won in previous years.

+

This year we had a number of winners from Asia. We saw our second +winner from China and first from Korea. We are pleased to see +outstanding entries from areas of the world that have not been active in +past contests. Will we see an upswing of entries from South America, +Africa and Antarctica next year? :-)

+

Please note that judging is done completely anonymously. Please do +NOT reveal your identity in your source code. In the future we may +disqualify entries that reveal the identity of the submitter!

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

There is a risk in submitting an entry that is similar to a well used +theme by previous winners. Previous winners set a very high bar. A new +winner must not only compete against other submissions form the current +year, they must also excel over similar winners in some particularly +impressive way.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2012,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2012 - The 21st IOCCC

+

Download IOCCC 2012 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2013/index.html b/2013/index.html new file mode 100644 index 000000000..eb9141971 --- /dev/null +++ b/2013/index.html @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + + + +2013 - The 22nd IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2013 - The 22nd IOCCC

+
+ + + + +
+ ← 2012 + ↑ top ↑ + 2014 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twenty +Second International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile the entry and how to run the winning +program. Look at the winning source and try to figure how it does what +it does! You may then wish to look at the Author’s remarks for even more +details.

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at: https://www.ioccc.org/

+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

Read over the Makefile for compile/build issues. Your system might +require certain changes (add or remove a library, add or remove a +#define i.e. -D flag).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

Remarks on some of the +entries

+

We believe you will again be impressed with this year’s winners.

+

This year, 9 won 15 awards. For the first time in the history of the +contest, one person, Yusuke Endoh +won 4 times while Adrian Cable +won 3 times! It is also worth noting that Chris +Mills last win was in 1993. Welcome back Chris!

+

We, the judges, were very surprised by this as many of the multiple +winners submitted very different styles of entries.

+

This year was the first time the IOCCC size tool was used. Entries +had to print a value 2053 or less when the -i flag was +used.

+

Several people discovered an undocumented feature in that certain +comments such as:

+
    ///*
+

or:

+
    *\
+    /
+

were not correctly parsed by the tool. The guidelines stated:

+
In cases where the above summary and the algorithm implemented by
+the IOCCC size tool source code conflict, the algorithm implemented
+by the IOCCC size tool source code is preferred by the judges.
+

so this abuse was allowed (and encouraged). The judges hope that the +IOCCC size tool author will patch the tool to block this kind of size +abuse in future contests.

+

There were some outstanding entries that did not win. Unfortunately +some very good entries lost because they:

+ +

We hope that the authors of some of those entries will fix and +resubmit them for the next IOCCC.

+

There is a risk in submitting an entry that is similar to a well used +theme by previous winners. Previous winners set a very high bar. A new +winner must not only compete against other submissions from the current +year but they must also excel over similar previous winners in some +particularly impressive way.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2013,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2013 - The 22nd IOCCC

+

Download IOCCC 2013 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2014/index.html b/2014/index.html new file mode 100644 index 000000000..4b3be26ee --- /dev/null +++ b/2014/index.html @@ -0,0 +1,273 @@ + + + + + + + + + + + + + + + + + + + + + +2014 - The 23rd IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2014 - The 23rd IOCCC

+
+ + + + +
+ ← 2013 + ↑ top ↑ + 2015 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twenty +Third International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at,

+ +

Use make to compile entries. It is possible that on non-Un*x / +non-Linux systems the makefile needs to be changed. See the Makefile for +details.

+

Look at the source and try to figure out what the programs do, and +run them with various inputs. If you want to, look at the hints files +for spoilers - this year we included most of the information included by +the submitter.

+

Read over the makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

Remarks on some of the +entries

+

We believe you will again be impressed with this year’s winners.

+

This year, 2014:

+

We, the judges, were very surprised by this as many of the multiple +winners submitted very different styles of entries.

+

This year was the second time the IOCCC size tool was used. Rule 2 +required that when program source is fed as input to the current IOCCC +size tool, and the IOCCC size tool -i command line option is used, the +value printed should be less than or equal to 2053.

+

We were pleased to see that abuse of the rules was extended to abuse +to the IOCCC size tool. Matt Zucker, followed by a few users, were able +to discover cleaver use of certain // comments to perplex the size tool. +The abuse was so bad that the judges released a critical and mandatory +patch to the IOCCC size tool on 2014-09-23.

+

There were some great entries that did not win. Unfortunately some +entries lost because they:

+ +

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

There is a risk in submitting an entry that is similar to a well used +theme by previous winners. Previous winners set a very high bar. A new +winner must not only compete against submissions from the current year, +they must also excel over any similar winners in some particularly +impressive way.

+

On the delay in releasing +the winners

+

We apologize on the delay of sending the winners the tarball for them +to review. There were some unforeseen events, such as unplanned +mandatory business travel, the death of a IOCCC judge mother, etc. that +impacted our planned schedule for building the IOCCC winner tarball.

+

During some of these forced delays, we took the time to better +automate some of the tools needed to package the source for the winners +to review and to post the edited winners to the web site. It is our +intent that these changes made during those delays will make releasing +future IOCCC winners a faster procedure.

+

p.s. The final advice given to Landon by his mom: “Have fun.” We +recommend following this advice were possible.

+

Final Comments

+

Please feel free to send us comments and suggestions about the +competition, this README or anything else that you would like to see in +future contests.

+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is +used.

+

If you have problems with any of the entries, AND YOU HAVE A FIX, +please send us the fix (patch file or the entire changed file).

+

For the latest information on how to contact the IOCCC Judges please +visit

+ +

For news of the next contest watch:

+ +

Copyright and License

+

Copyright (C) 2014,2024, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2014 - The 23rd IOCCC

+

Download IOCCC 2014 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2015/index.html b/2015/index.html new file mode 100644 index 000000000..7bb5717f6 --- /dev/null +++ b/2015/index.html @@ -0,0 +1,284 @@ + + + + + + + + + + + + + + + + + + + + + +2015 - The 24th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2015 - The 24th IOCCC

+
+ + + + +
+ ← 2014 + ↑ top ↑ + 2018 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twenty +Fourth International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

The IOCCC has a web site and now has a number of international +mirrors. The primary site can be found at,

+ +

Use make to compile entries. It is possible that on non-Un*x / +non-Linux systems the makefile needs to be changed. See the Makefile for +details.

+

Look at the source and try to figure out what the programs do, and +run them with various inputs. If you want to, look at the hints files +for spoilers - this year we included most of the information included by +the submitter.

+

Read over the makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some ANSI C compilers are not quite as good as they should be. If +yours is lacking, you may need to compile using gcc instead of your +local compiler.

+

Remarks on some of the +winners

+

We believe you will again be impressed with this year’s winners.

+

The fraction of worthy entries was higher than usual.

+

We call to your attention, the hou entry, that performs the +MD5 cryptographic hash. Normally implemented with a set of integer and +boolean operations, this code uses floating point variables inside a +single while loop filled with unusual constants, cosine, square root, +and exponent function calls. The number of lines of code is also smaller +than the original algorithm.

+

The mills2 source code is a very compressed version of a +decompression algorithm. We think those who enjoy compression algorithms +will particularly enjoy this entry.

+

We suggest that you attempt to completely understand the +endoh4 1-liner program: another impressive compact piece of C +code.

+

And while you are at it, cat the endoh2 prog.c code. Compile +it and look at the source code again.

+

In a “Back to the Future” moment, endoh3 gave us a twist on +one of the all time best IOCCC winners from 1984.

+

We also suggest that you take a very good look at how the +muth code makes full use of the C Pre-Processor.

+

…We’ll stop spouting spoilers now. Have fun exploring all the +entries!

+

Remarks on some +of submissions that did not win

+

The number of entries that would have made it into the final rounds +would have been much higher had some people paid attention to rules 2 +and 22 (one third of 666).

+

Rule 22, now known as Catch 22 states:

+
|  22) Your source code, data files, remarks and program output must NOT
+|      identify the authors of your code.  The judges STRONGLY prefer to
+|      not know who is submitting entries to the IOCCC.
+
+|      The "Peter Honeyman is exempt" guideline also applies to this rule.
+|      Identifying yourself, in an obvious way in your code, data, remarks
+|      or program output, unless you are Peter Honeyman or pretending
+|      to be Peter Honeyman, will be grounds for disqualification of your entry.
+

A number of other entries were based on iocccsize.c, making +derivative works rather than original works.

+

Still other entries were too large, violating the first line of rule +2:

+
    +
  1. The size of your program source must be <= 4096 bytes in +length.
  2. +
+

While these entries might have passed under the 2053 limit for +iocccsize, they were larger than <= 4096 bytes, sometimes by an order +or magnitude.

+

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

Final Comments

+

Please feel free to send us comments and suggestions about the +competition, this README or anything else that you would like to see in +future contests.

+

If you use, distribute or publish these entries in some way, please +drop us a line. We enjoy seeing who, where and how the contest is +used.

+

If you have problems with any of the entries, AND YOU HAVE A FIX, +please send us the fix (patch file or the entire changed file).

+

For the latest information on how to contact the IOCCC Judges please +visit

+ +

For news of the next contest watch:

+ +

Copyright and License

+

Copyright (C) 2015,2024, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2015 - The 24th IOCCC

+

Download IOCCC 2015 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2018/index.html b/2018/index.html new file mode 100644 index 000000000..b8500a92d --- /dev/null +++ b/2018/index.html @@ -0,0 +1,270 @@ + + + + + + + + + + + + + + + + + + + + + +2018 - The 25th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2018 - The 25th IOCCC

+
+ + + + +
+ ← 2015 + ↑ top ↑ + 2019 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twenty +Fifth International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

The primary IOCCC web site can be found at,

+
+

https://www.ioccc.org/

+
+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

Look at the source and try to figure out what the programs do, and +run them with various inputs. If you want to, look at the hints files +for spoilers - this year we included most of the information included by +the submitter.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some C compilers are not quite as good as they should be. If yours is +lacking, you may need to compile using clang or gcc instead of your +local compiler.

+

Remarks on some of the +winners

+

We believe you will again be impressed with this year’s winners.

+

The “Best of show” (mills) is an amazing tribute to winners from 1984 +and 2015.

+

Take a close look at the “Most likely to top the charts” (hou) +winner. Observe that while it contains no variables and no operators, it +remains functional in what it does.

+

The “Best one-liner” (burton1), at 109 characters, is a short and +sweet implementation of a classic utility and a nod to a winner from +1986. Sometimes it takes 20 ox years to do things the true IOCCC +way.

+

The color of the remarks text this year was inspired by one of the +stars of the “Most stellar” winner (poikola).

+

The “Best use of python” (endoh2) is a not what you might think it +is. It is something completely different.

+

The “Most likely to be awarded” (ciura) has an amazing +vocabulary!

+

There are also nods to winners of the years 2000 (bellard), 1989 +(yang), …

+

…We’ll stop spouting spoilers now. Have fun exploring all the +entries!

+

Remarks on some +of submissions that did not win

+

The number of entries that would have made it into the final rounds +would have been much higher had some people paid attention to rules 2 +and 22 (one third of 666).

+

Rule 22, now known as “Catch 22” states:

+
|  22) Your source code, data files, remarks and program output must NOT
+|      identify the authors of your code.  The judges STRONGLY prefer to
+|      not know who is submitting entries to the IOCCC.
+
+|      The "Peter Honeyman is exempt" guideline also applies to this rule.
+|      Identifying yourself, in an obvious way in your code, data, remarks
+|      or program output, unless you are Peter Honeyman or pretending
+|      to be Peter Honeyman, will be grounds for disqualification of your entry.
+

A number of other entries were based on iocccsize.c, making +derivative works rather than original works.

+

Still other entries were too large, violating the first line of rule +2:

+
2) The size of your program source must be <= 4096 bytes in length.
+

While these entries might have passed under the 2053 limit for +iocccsize, they were larger than <= 4096 bytes, sometimes by an order +or magnitude.

+

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

Some entries seemed to have a good idea, but the implementation of +the idea was limited in scope.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (C) 2018,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2018 - The 25th IOCCC

+

Download IOCCC 2018 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2019/index.html b/2019/index.html new file mode 100644 index 000000000..011ed6bf0 --- /dev/null +++ b/2019/index.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + + + +2019 - The 26th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2019 - The 26th IOCCC

+
+ + + + +
+ ← 2018 + ↑ top ↑ + 2020 → + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twenty +Sixth International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The primary IOCCC web site can be found at,

+
+

https://www.ioccc.org/

+
+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some C compilers are not quite as good as they should be. If yours is +lacking, you may need to compile using clang or gcc instead of your +local compiler.

+

Remarks on some of the +winners

+

This year’s winners are impressive!

+

The “Most in need of debugging” (endoh) is very inventive in a way it +produces its own text!

+

The “Most likely to be awarded” (ciura) has an amazing +vocabulary!

+

There are again nods to winners of the years:

+
[1991/davidguy](http://ioccc.org/years.html#1991_davidguy)
+[2011/blakely](http://ioccc.org/years.html#2011_blakely)
+

These nods to not run afoul of the guideline:

+
We tend to dislike programs that:
+...
+are rather similar to previous winners
+

because the entry (dogon) appropriately pays homage to past winners +without blatantly reusing their code.

+

…We’ll stop spouting spoilers now. Have fun exploring all the +entries!

+

Remarks on some +of submissions that did not win

+

Some entries tried to get around the size limit by submitting a data +file that was really C code and then blindly including code in +prog.c.

+

Quite a few entries suffered from undefined behavior like accessing +uninitialized locals and/or reading-writing below the stack. We advise +running your entry through valgrind to make sure those mistakes are +avoided.

+

Using extra arguments to main, or arguments of wrong types as a quick +and dirty way of declaring variables is now passé. Clang, for example, +rejects them outright.

+

We hope the authors of some of those entries will fix and re-submit +them for the next IOCCC.

+

Some entries seemed to have a good idea, but the implementation of +the idea was limited in scope.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (c) 2019,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2019 - The 26th IOCCC

+

Download IOCCC 2019 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/2020/index.html b/2020/index.html new file mode 100644 index 000000000..530825d5d --- /dev/null +++ b/2020/index.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + + + +2020 - The 27th IOCCC + + + + + + + + + + + + +
+ IOCCC image by Matt Zucker +

The International Obfuscated C Code Contest

+

2020 - The 27th IOCCC

+
+ + + + +
+ ← 2019 + ↑ top ↑ + In most recent year + Inventory +
+ + + + +
+ + + + +
+ + + + + +
+ +
+ +
+ +
+ +
+ + + + + +
+ + + + +
+ + + + + + + + + +

Twenty +Seventh International Obfuscated C Code Contest

+

Standard IOCCC stuff

+

Look at the README.md file for the given winning entry for +information on how to compile it and how to run the winning program. +Look at the winning source and try to figure how it does what it does! +You may then wish to look at the Author’s remarks for even more +details.

+

The primary IOCCC web site can be found at,

+
+

https://www.ioccc.org/

+
+

Use make to compile entries. It is possible that on +non-Unix / non-Linux systems the Makefile needs to be changed. See the +Makefile for details.

+

Read over the Makefile for compile/build issues. Your system may +require certain changes (add or remove a library, add or remove a +#define).

+

Some C compilers are not quite as good as they should be. If yours is +lacking, you may need to compile using clang or gcc instead of your +local compiler.

+

Remarks on some of the +winners

+

This year’s Best of Show (carlini) is such a novel way of obfuscation +that it would be worth of a special mention in the (future) Best of +IOCCC list!

+

For some reason, this year’s set of winners contains three nostalgic +games, Asteroids (tsoj), Minesweeper (endoh1), and Snake +(ferguson1).

+

An entry (kurdyukov1) pays homage to a previous winner +(2015/hou).

+

…We’ll stop spouting spoilers now. Have fun exploring all the +entries!

+

Remarks on some +of submissions that did not win

+

As a rule, we try to compile the entries on a variety of platforms. +Quite a few entries this year could not be built or executed on some of +them due to reliance on library internals or the system runtime.

+

A few entries were violating the “2053 significant bytes” rule. If an +entry could not be brought to compliance within a few seconds of looking +at the source, it was disqualified.

+

One entry tried to get around the size limit by putting the code into +Makefile variables and using -D. This is already called out as +discouraged technique in the guidelines, but it is worth a reminder.

+

Several promising entries attempted to make use of the +syscall function using literal syscall numbers. This is +utterly non-portable.

+

A note to the authors: when submitting multiple entries, don’t let us +easily correlate them by coding style or documentation content, and +definitely don’t submit nearly identical versions of your program +separately. As we try to judge the entries anonymously, the similarities +will cause such entries to compete against one another, making each less +likely to win.

+

We hope the authors of non-winning entries will refine their entries +and perhaps re-submit them for the next IOCCC.

+

Final Comments

+

IMPORTANT NOTE: See contact.html for up to date contact details as +well as details on how to provide fixes to any of the entries. See also +the IOCCC FAQ for addition information on the +IOCCC.

+

Copyright and License

+

Copyright (C) 2020,2023, Landon Curt Noll and Leonid A. Broukhis. All +Rights Reserved. This work is licensed under a Creative Commons +CC BY-SA 4.0 DEED Attribution-ShareAlike 4.0 International license. +If you do use this work in some form, the IOCCC +judges would appreciate (but does not require) if you were to send us a note about your use.

+ + + + + + +

Winning +Entries of 2020 - The 27th IOCCC

+

Download IOCCC 2020 entry source

+ +

 Jump to: top

+ + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + diff --git a/Makefile b/Makefile index ab625cc28..abbb795c3 100644 --- a/Makefile +++ b/Makefile @@ -40,10 +40,19 @@ include var.mk # IOCCC web site maintenance tulz ################################# +# NOTE: The "tulz" (tools) in this section are intended to be used by those +# who maintain the official IOCCC site. +# +# We file "tulz" paths should be relative to the top directory of the repo. +# We need only list those "tulz" that are invoked directly by the +# "IOCCC web site maintenance rulz" section below. + ALL_RUN= bin/all-run.sh +ALL_YEARS= bin/all-years.sh GEN_AUTHORS= bin/gen-authors.sh GEN_LOCATION= bin/gen-location.sh GEN_YEARS= bin/gen-years.sh +GEN_YEAR_INDEX= bin/gen-year-index.sh README2INDEX= bin/readme2index.sh QUICK_README2INDEX= bin/quick-readme2index.sh @@ -224,8 +233,25 @@ indent.c: # XXX - The rules in this section are undergoing development and change. # They might not even work (right now). :-) -.PHONY: genpath gen_authors gen_location gen_years entry_index quick_entry_index \ - quick_www www +.PHONY: help genpath gen_authors gen_location gen_years entry_index quick_entry_index \ + gen_year_index quick_www www + +# Suggest rules in this section +# +# This may not be much help to people who are not already familiar with +# the tools needed to build the web site, but it is does print out a friendly +# reminder to hose who to understand. For all else, there is "RTFS". :-) +# +help: + @echo make genpath + @echo make gen_authors + @echo make gen_location + @echo make gen_years + @echo make entry_index + @echo make gen_year_index + @echo make quick_entry_index + @echo make quick_www + @echo make www # form the top level .top, YYYY level .year and winner level .path files # @@ -275,6 +301,13 @@ entry_index: ${ALL_RUN} ${README2INDEX} ${ALL_RUN} -v 3 ${README2INDEX} -v 1 @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' +# generate year level index.html files +# +gen_year_index: ${ALL_YEARS} ${GEN_YEAR_INDEX} + @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' + ${ALL_YEARS} -v 1 ${GEN_YEAR_INDEX} -v 1 + @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' + # build winner index.html files that might be out of date # # This rule uses the QUICK_README2INDEX tool, so @@ -299,6 +332,7 @@ quick_www: ${MAKE} gen_authors ${MAKE} gen_location ${MAKE} gen_years + ${MAKE} gen_year_index ${MAKE} quick_entry_index @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' @@ -311,6 +345,7 @@ www: ${MAKE} gen_authors ${MAKE} gen_location ${MAKE} gen_years + ${MAKE} gen_year_index ${MAKE} entry_index @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' diff --git a/bin/README.md b/bin/README.md index c1fc41978..9fc787a42 100644 --- a/bin/README.md +++ b/bin/README.md @@ -30,6 +30,17 @@ bin/all-run.sh -v 3 bin/readme2index.sh -v 1 ``` +### [all-years.sh](all-years.sh) + +Run a command on all IOCCC years. + +For example: + +```sh +all-years.sh -v 1 bin/gen-year-index.sh -v 1 +``` + + ### [gen-authors.sh](gen-authors.sh) Generate the top level `/authors.html` page. @@ -52,6 +63,17 @@ bin/gen-location.sh -v 1 ``` +### [gen-year-index.sh](gen-year-index.sh) + +Generate an `index.html` page for an given IOCCC year. + +Usage: + +```sh +bin/gen-year-index.sh -v 1 2020 +``` + + ### [gen-years.sh](gen-years.sh) Generate the top level `/years.html` page. @@ -173,7 +195,7 @@ bin/all-run.sh bin/sort.gitignore.sh -v 1 Print default substitutions. -### [subst.entry-index..sh](subst.entry-index..sh) +### [subst.entry-index.sh](subst.entry-index.sh) Print substitutions for a entry index.html. @@ -183,6 +205,16 @@ Print substitutions for a entry index.html. Output substitutions for navbar on behalf of a entry. +### [subst.year-index.sh](subst.year-index.sh) + +Print substitutions for a year level index.html. + + +### [subst.year-navbar.awk](subst.year-navbar.awk) + +Output substitutions for navbar on behalf of a year level index.html. + + # How IOCCC HTML content is built The [md2html.sh](md2html.sh) tool is the primary tool that diff --git a/bin/all-run.sh b/bin/all-run.sh index 82a3d1824..163abe3f6 100755 --- a/bin/all-run.sh +++ b/bin/all-run.sh @@ -21,11 +21,11 @@ # # For example: # -# all-run.sh -v 3 -t readme2html -U https://www.ioccc.org bin/quick-readme2html.sh -v 1 +# all-run.sh -v 3 -t readme2html -w https://www.ioccc.org bin/quick-readme2html.sh -v 1 # # will run the tool bin/quick-readme2html.sh for each entry YYYY/dir as follows: # -# bin/quick-readme2html.sh -t readme2html -U https://www.ioccc.org YYYY/dir -v 1 +# bin/quick-readme2html.sh -t readme2html -w https://www.ioccc.org YYYY/dir -v 1 # # Only the "-D -t, -T, -p, -u, -w" option set are passed to the tool command line. # For all other special tool options, pass them as additional tool options (i.e., command line arguments @@ -93,6 +93,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="../../" export TAGLINE="unspecified" export MD2HTML_SH="bin/md2html.sh" @@ -128,8 +129,9 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N] -N do not process anything, just parse arguments (def: process something) -t tagline string to write about the tool that formed the markdown content (def: $TAGLINE) - NOTE: 'pandoc_opts' may be enclosed within, but may NOT contain an internal single-quote or double-quote. + NOTE: The '-t tagline' is passed as leading options on tool command lines. -T md2html.sh run 'markdown to html tool' to convert markdown into HTML (def: $MD2HTML_SH) + NOTE: The '-T md2html.sh' is passed as leading options on tool command lines. -p tool run 'pandoc wrapper tool' (not pandoc path) during HTML phase number 21 (def: use $PANDOC_WRAPPER) @@ -142,7 +144,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N] tool the tool to run over all entries [more_options] additional tool command line options to use before the YYYY/dir argument -NOTE: Any '-t tagline', '-T md2html.sh', '-p tool', '-P pandoc_opts', '-u repo_url', '-U top_url' +NOTE: Any '-D docroot/', '-t tagline', '-T md2html.sh', '-p tool', '-u repo_url', '-w site_url' are passed to the 'tool' at the beginning of the command line, and before any optional 'more_options' and before the final YYYY/dir argument. @@ -376,7 +378,6 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 - echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2 echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: TAGLINE=$TAGLINE" 1>&2 echo "$0: debug[3]: MD2HTML_SH=$MD2HTML_SH" 1>&2 @@ -391,6 +392,7 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: TOOL_OPTION[$index]=${TOOL_OPTION[$index]}" 1>&2 done echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 + echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2 fi # -N stops early before any processing is performed diff --git a/bin/all-years.sh b/bin/all-years.sh new file mode 100755 index 000000000..3eee0c431 --- /dev/null +++ b/bin/all-years.sh @@ -0,0 +1,496 @@ +#!/usr/bin/env bash +# +# all-years.sh - run a command for all IOCCC years +# +# We cd to topdir, than then walk the entry directory tree. +# We obtain the set of IOCCC years (YYYY) via the .top file. +# For each year (YYYY), we run the tool. +# +# The tool argument, if not an absolute path, must be relative to topdir. +# The tool argument is the first argument command line. Any additional +# arguments beyond the first tool argument are treated as more tool options. +# +# NOTE: A command line option is a dashed letter (e.g., -n or --) followed by an optional string (e.g., -v 3). +# Command line arguments follow any command line options (including any final -- option). +# While the 1st command line cannot start with a dash, optional line arguments that follow by start with a dash. +# +# Each tool run with command line of the form: +# +# tool [any -D, -t tagline, -T md2html.sh, -p tool, -u repo_url, -w site_url] [more_options] YYYY +# +# For example: +# +# all-years.sh -v 3 -w https://www.ioccc.org bin/gen-year-index,sh bin/gen-year-index.sh -v 1 +# +# will run the tool bin/quick-readme2html.sh for each entry YYYY as follows: +# +# bin/gen-year-index.sh -w https://www.ioccc.org YYYY -v 1 +# +# Only the "-D -t, -T, -p, -u, -w" option set are passed to the tool command line. +# For all other special tool options, pass them as additional tool options (i.e., command line arguments +# that follow the 1st command line argument) OR consider simply running the tool directly. +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# +# Permission to use, copy, modify, and distribute this software and +# its documentation for any purpose and without fee is hereby granted, +# provided that the above copyright, this permission notice and text +# this comment, and the disclaimer below appear in all of the following: +# +# supporting documentation +# source copies +# source works derived from this source +# binaries derived from this source or from derived source +# +# LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, +# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO +# EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR +# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF +# USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +# PERFORMANCE OF THIS SOFTWARE. +# +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# Share and enjoy! :-) + +# firewall - must be bash with a version 4.2 or later +# +# We must declare arrays with -ag or -Ag, and we need loops to "export" modified variables. +# +if [[ -z ${BASH_VERSINFO[0]} || ${BASH_VERSINFO[0]} -lt 4 || ${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 2 ]]; then + echo "$0: ERROR: bash version must be >= 4.2: $BASH_VERSION" 1>&2 + exit 4 +fi + +# setup bash file matching +# +# Requires bash with a version 4.2 or later +# +shopt -s nullglob # enable expanded to nothing rather than remaining unexpanded +shopt -u failglob # disable error message if no matches are found +shopt -u dotglob # disable matching files starting with . +shopt -s globskipdots # enable never matching . or .. +shopt -u nocaseglob # disable strict case matching +shopt -u extglob # enable extended globbing patterns +shopt -s globstar # enable ** to match all files and zero or more directories and subdirectories + +# set variables referenced in the usage message +# +export VERSION="1.0 2024-02-12" +NAME=$(basename "$0") +export NAME +export V_FLAG=0 +GIT_TOOL=$(type -P git) +export GIT_TOOL +if [[ -z "$GIT_TOOL" ]]; then + echo "$0: FATAL: git tool is not installed or not in \$PATH" 1>&2 + exit 10 +fi +"$GIT_TOOL" rev-parse --is-inside-work-tree >/dev/null 2>&1 +status="$?" +if [[ $status -eq 0 ]]; then + TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) +fi +export TOPDIR +export DOCROOT_SLASH="../../" +export TAGLINE="unspecified" +export MD2HTML_SH="bin/md2html.sh" +export PANDOC_WRAPPER="bin/pandoc-wrapper.sh" +export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" +export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc" +# +export NOOP= +export DO_NOT_PROCESS= +export EXIT_CODE="0" + +# clear options we will add to tools +# +unset TOOL_OPTION +declare -ag TOOL_OPTION + +# usage +# +export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N] + [-t tagline] [-T md2html.sh] [-p tool] [-u repo_url] [-w site_url] + tool [more_options] + + -h print help message and exit + -v level set verbosity level (def level: 0) + NOTE: The '-v level' is passed as leading options on tool command lines. + -V print version string and exit + + -d topdir set topdir (def: $TOPDIR) + -D docroot/ set the document root path followed by slash (def: $DOCROOT_SLASH) + NOTE: The '-D docroot/' is passed as leading options on tool command lines. + NOTE: 'docroot' must end in a slash + + -n go thru the actions, but do not update any files (def: do the action) + -N do not process anything, just parse arguments (def: process something) + + -t tagline string to write about the tool that formed the markdown content (def: $TAGLINE) + NOTE: The '-t tagline' is passed as leading options on tool command lines. + -T md2html.sh run 'markdown to html tool' to convert markdown into HTML (def: $MD2HTML_SH) + NOTE: The '-T md2html.sh' is passed as leading options on tool command lines. + + -p tool run 'pandoc wrapper tool' (not pandoc path) during HTML phase number 21 (def: use $PANDOC_WRAPPER) + + -u repo_url Base level URL of target git repo (def: $REPO_URL) + NOTE: The '-u repo_url' is passed as leading options on tool command lines. + + -w site_url Base URL of the web site (def: $SITE_URL) + NOTE: The '-w site_url' is passed as leading options on tool command lines. + + tool the tool to run over all entries + [more_options] additional tool command line options to use before the YYYY/dir argument + +NOTE: Any '-t tagline', '-T md2html.sh', '-p tool', '-u repo_url', '-w site_url' + are passed to the 'tool' at the beginning of the command line, and + before any optional 'more_options' and before the final YYYY/dir argument. + +Exit codes: + 0 all OK + 1 some tool exited non-zero + 2 -h and help string printed or -V and version string printed + 3 command line error + 4 bash version is < 4.2 + 5 tool and/or md2html.sh is not an executable file + 6 problems found with or in the topdir directory + 7 problems found with or in the topdir/YYYY directory + 8 problems found with or in the topdir/YYYY/dir directory + >= 10 < 200 internal error + >= 200 ((not used)) + +$NAME version: $VERSION" + +# parse command line +# +while getopts :hv:Vd:D:nNt:T:p:u:w: flag; do + case "$flag" in + h) echo "$USAGE" 1>&2 + exit 2 + ;; + v) V_FLAG="$OPTARG" + ;; + V) echo "$VERSION" + exit 2 + ;; + d) TOPDIR="$OPTARG" + ;; + D) # parse -D docroot/ + case "$OPTARG" in + */) ;; + *) echo "$0: ERROR: in -D docroot/, the docroot must end in /" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + esac + DOCROOT_SLASH="$OPTARG" + TOOL_OPTION+=("-D") + TOOL_OPTION+=("$DOCROOT_SLASH") + ;; + n) NOOP="-n" + ;; + N) DO_NOT_PROCESS="-N" + ;; + t) # parse -t tagline + case "$OPTARG" in + *"'"*) + echo "$0: ERROR: in -t tagline, the tagline may not contain a single-quote character: $OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + *'"'*) + echo "$0: ERROR: in -t tagline, the tagline may not contain a double-quote character: $OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + *) ;; + esac + TAGLINE="$OPTARG" + TOOL_OPTION+=("-t") + TOOL_OPTION+=("$TAGLINE") + ;; + T) MD2HTML_SH="$OPTARG" + TOOL_OPTION+=("-T") + TOOL_OPTION+=("$MD2HTML_SH") + ;; + p) PANDOC_WRAPPER="$OPTARG" + TOOL_OPTION+=("-p") + TOOL_OPTION+=("$PANDOC_WRAPPER") + ;; + u) REPO_URL="$OPTARG" + TOOL_OPTION+=("-u") + TOOL_OPTION+=("$REPO_URL") + ;; + w) SITE_URL="$OPTARG" + TOOL_OPTION+=("-w") + TOOL_OPTION+=("$SITE_URL") + ;; + \?) echo "$0: ERROR: invalid option: -$OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + :) echo "$0: ERROR: option -$OPTARG requires an argument" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + *) echo "$0: ERROR: unexpected value from getopts: $flag" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + esac +done + +# remove the options +# +shift $(( OPTIND - 1 )); +# +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: file argument count: $#" 1>&2 +fi +# +# verify arg count and parse args +# +export TOOL +case "$#" in +0) echo "$0: ERROR: expected 1 or more args, found: $#" 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; +1) TOOL="$1" + ;; +*) TOOL="$1" + shift + while [[ $# -gt 0 ]]; do + TOOL_OPTION+=("$1") + shift + done + ;; +esac + +# verify that we have a topdir directory +# +REPO_NAME=$(basename "$REPO_URL") +export REPO_NAME +if [[ -z $TOPDIR ]]; then + echo "$0: ERROR: cannot find top of git repo directory" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 6 +fi +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR does not exist: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 6 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR is not a directory: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 6 +fi + +# cd to topdir +# +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to non-existent path: $TOPDIR" 1>&2 + exit 6 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to a non-directory: $TOPDIR" 1>&2 + exit 6 +fi +export CD_FAILED +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: about to: cd $TOPDIR" 1>&2 +fi +cd "$TOPDIR" || CD_FAILED="true" +if [[ -n $CD_FAILED ]]; then + echo "$0: ERROR: cd $TOPDIR failed" 1>&2 + exit 6 +fi +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2 +fi + +# verify we have a non-empty readable .top file +# +export TOP_FILE=".top" +if [[ ! -e $TOP_FILE ]]; then + echo "$0: ERROR: .top does not exist: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -f $TOP_FILE ]]; then + echo "$0: ERROR: .top is not a regular file: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -r $TOP_FILE ]]; then + echo "$0: ERROR: .top is not an readable file: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -s $TOP_FILE ]]; then + echo "$0: ERROR: .top is not a non-empty readable file: $TOP_FILE" 1>&2 + exit 6 +fi + +# verify tool is executable +# +if [[ ! -e $TOOL ]]; then + echo "$0: ERROR: TOOL does not exist: $TOOL" 1>&2 + exit 5 +fi +if [[ ! -f $TOOL ]]; then + echo "$0: ERROR: TOOL is not a regular file: $TOOL" 1>&2 + exit 5 +fi +if [[ ! -x $TOOL ]]; then + echo "$0: ERROR: TOOL is not an executable file: $TOOL" 1>&2 + exit 5 +fi + +# verify that the md2html.sh is executable +# +if [[ ! -e $MD2HTML_SH ]]; then + echo "$0: ERROR: md2html.sh does not exist: $MD2HTML_SH" 1>&2 + exit 5 +fi +if [[ ! -f $MD2HTML_SH ]]; then + echo "$0: ERROR: md2html.sh is not a regular file: $MD2HTML_SH" 1>&2 + exit 5 +fi +if [[ ! -x $MD2HTML_SH ]]; then + echo "$0: ERROR: md2html.sh is not an executable file: $MD2HTML_SH" 1>&2 + exit 5 +fi + +# print running info if verbose +# +# If -v 3 or higher, print exported variables in order that they were exported. +# +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 + echo "$0: debug[3]: NAME=$NAME" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 + echo "$0: debug[3]: TAGLINE=$TAGLINE" 1>&2 + echo "$0: debug[3]: MD2HTML_SH=$MD2HTML_SH" 1>&2 + echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 + echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 + echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: EXIT_CODE=$EXIT_CODE" 1>&2 + echo "$0: debug[3]: TOOL=$TOOL" 1>&2 + for index in "${!TOOL_OPTION[@]}"; do + echo "$0: debug[3]: TOOL_OPTION[$index]=${TOOL_OPTION[$index]}" 1>&2 + done + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 +fi + +# -N stops early before any processing is performed +# +if [[ -n $DO_NOT_PROCESS ]]; then + if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: arguments parsed, -N given, exiting 0" 1>&2 + fi + exit 0 +fi + +# process each year +# +export YYYY +for YYYY in $(< "$TOP_FILE"); do + + # debug YYYY + # + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: starting to process year: $YYYY" 1>&2 + fi + + # verify that YYYY is a readable directory + # + if [[ ! -e $YYYY ]]; then + echo "$0: ERROR: YYYY does not exist: $YYYY" 1>&2 + EXIT_CODE="7" # exit 7 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + if [[ ! -d $YYYY ]]; then + echo "$0: ERROR: YYYY is not a directory: $YYYY" 1>&2 + EXIT_CODE="7" # exit 7 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + if [[ ! -r $YYYY ]]; then + echo "$0: ERROR: YYYY is not an readable directory: $YYYY" 1>&2 + EXIT_CODE="7" # exit 7 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + + # verify that YYYY has a non-empty readable .year file + # + export YEAR_FILE="$YYYY/.year" + if [[ ! -e $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year does not exist: $YEAR_FILE" 1>&2 + EXIT_CODE="7" # exit 7 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + if [[ ! -f $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not a regular file: $YEAR_FILE" 1>&2 + EXIT_CODE="7" # exit 7 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + if [[ ! -r $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not an readable file: $YEAR_FILE" 1>&2 + EXIT_CODE="7" # exit 7 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + if [[ ! -s $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not a non-empty readable file: $YEAR_FILE" 1>&2 + EXIT_CODE="7" # exit 7 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + + # run the tool unless -n + # + if [[ -z $NOOP ]]; then + if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: about to run: $TOOL ${TOOL_OPTION[*]} -- $YYYY" 1>&2 + fi + "$TOOL" "${TOOL_OPTION[@]}" -- "$YYYY" + status="$?" + if [[ $status -ne 0 ]]; then + echo "$0: ERROR: tool: $TOOL ${TOOL_OPTION[*]} -- $YYYY failed, error: $status" 1>&2 + EXIT_CODE="1" # exit 1 + echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2 + continue + fi + + # report disabled by -n + # + elif [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: because of -n, did not run: $TOOL ${TOOL_OPTION[*]} -- $YYYY" 1>&2 + fi +done + +# All Done!!! -- Jessica Noll, Age 2 +# +if [[ $EXIT_CODE -ne 0 ]]; then + echo "$0: Warning: about to exit non-zero: $EXIT_CODE" 1>&2 +elif [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: about to exit $EXIT_CODE" 1>&2 +fi +exit "$EXIT_CODE" diff --git a/bin/gen-authors.sh b/bin/gen-authors.sh index 19f284a44..247d32edf 100755 --- a/bin/gen-authors.sh +++ b/bin/gen-authors.sh @@ -64,6 +64,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="./" export TAGLINE="bin/$NAME" export MD2HTML_SH="bin/md2html.sh" @@ -630,22 +631,23 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: NAME=$NAME" 1>&2 echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: TAGLINE=$TAGLINE" 1>&2 echo "$0: debug[3]: MD2HTML_SH=$MD2HTML_SH" 1>&2 echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 - echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 - echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 - echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 - echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: NOOP=$NOOP" 1>&2 - echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: EXIT_CODE=$EXIT_CODE" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 for index in "${!TOOL_OPTION[@]}"; do echo "$0: debug[3]: TOOL_OPTION[$index]=${TOOL_OPTION[$index]}" 1>&2 done - echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 + echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 + echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 + echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 fi # -N stops early before any processing is performed diff --git a/bin/gen-location.sh b/bin/gen-location.sh index a042f83d4..491184e4d 100755 --- a/bin/gen-location.sh +++ b/bin/gen-location.sh @@ -64,6 +64,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="./" export TAGLINE="bin/$NAME" export MD2HTML_SH="bin/md2html.sh" @@ -358,23 +359,23 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: NAME=$NAME" 1>&2 echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: TAGLINE=$TAGLINE" 1>&2 echo "$0: debug[3]: MD2HTML_SH=$MD2HTML_SH" 1>&2 echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 - echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 - echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 - echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 - echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: NOOP=$NOOP" 1>&2 - echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: EXIT_CODE=$EXIT_CODE" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 for index in "${!TOOL_OPTION[@]}"; do echo "$0: debug[3]: TOOL_OPTION[$index]=${TOOL_OPTION[$index]}" 1>&2 done - echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 - echo "$0: debug[3]: LOCATION_TOOL=$LOCATION_TOOL" 1>&2 + echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 + echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 + echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 echo "$0: debug[3]: LOCATION_HTML=$LOCATION_HTML" 1>&2 fi diff --git a/bin/gen-year-index.sh b/bin/gen-year-index.sh new file mode 100755 index 000000000..3c2bcb82b --- /dev/null +++ b/bin/gen-year-index.sh @@ -0,0 +1,404 @@ +#!/usr/bin/env bash +# +# gen-year-index.sh - create year level index.html +# +# Create an index.html file for a given IOCCC year. +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# +# Permission to use, copy, modify, and distribute this software and +# its documentation for any purpose and without fee is hereby granted, +# provided that the above copyright, this permission notice and text +# this comment, and the disclaimer below appear in all of the following: +# +# supporting documentation +# source copies +# source works derived from this source +# binaries derived from this source or from derived source +# +# LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, +# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO +# EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR +# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF +# USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +# PERFORMANCE OF THIS SOFTWARE. +# +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# Share and enjoy! :-) + +# firewall - must be bash with a version 4.2 or later +# +# We must declare arrays with -ag or -Ag, and we need loops to "export" modified variables. +# +if [[ -z ${BASH_VERSINFO[0]} || ${BASH_VERSINFO[0]} -lt 4 || ${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 2 ]]; then + echo "$0: ERROR: bash version must be >= 4.2: $BASH_VERSION" 1>&2 + exit 4 +fi + +# setup bash file matching +# +# Requires bash with a version 4.2 or later +# +shopt -s nullglob # enable expanded to nothing rather than remaining unexpanded +shopt -u failglob # disable error message if no matches are found +shopt -u dotglob # disable matching files starting with . +shopt -s globskipdots # enable never matching . or .. +shopt -u nocaseglob # disable strict case matching +shopt -u extglob # enable extended globbing patterns +shopt -s globstar # enable ** to match all files and zero or more directories and subdirectories + +# set variables referenced in the usage message +# +export VERSION="1.0 2024-02-12" +NAME=$(basename "$0") +export NAME +export V_FLAG=0 +GIT_TOOL=$(type -P git) +export GIT_TOOL +if [[ -z "$GIT_TOOL" ]]; then + echo "$0: FATAL: git tool is not installed or not in \$PATH" 1>&2 + exit 210 +fi +"$GIT_TOOL" rev-parse --is-inside-work-tree >/dev/null 2>&1 +status="$?" +if [[ $status -eq 0 ]]; then + TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) +fi +export TOPDIR +export DOCROOT_SLASH="../../" +export TAGLINE="bin/$NAME" +export MD2HTML_SH="bin/md2html.sh" +export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" +export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc" + +# clear options we will add to tools +# +unset TOOL_OPTION +declare -ag TOOL_OPTION + +# set usage message +# +export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-n] [-N] + [-t tagline] [-T md2html.sh] [-u repo_url] [-w site_url] + YYYY [more_options] + + -h print help message and exit + -v level set verbosity level (def level: 0) + -V print version string and exit + + -d topdir set topdir (def: $TOPDIR) + -D docroot/ set the document root path followed by slash (def: $DOCROOT_SLASH) + NOTE: 'docroot' must end in a slash + + -n go thru the actions, but do not update any files (def: do the action) + -N do not process file, just parse arguments and ignore the file (def: process the file) + + -t tagline string to write about the tool that formed the markdown content (def: $TAGLINE) + -T md2html.sh run 'markdown to html tool' to convert markdown into HTML (def: $MD2HTML_SH) + + -u repo_url Base level URL of target git repo (def: $REPO_URL) + -w site_url Base URL of the web site (def: $SITE_URL) + + YYYY path from topdir to year directory: must contain the files: README.md, .path and .entry.json + [more_options] additional tool command line options to use before the YYYY argument + +Exit codes: + 0 all OK + 2 -h and help string printed or -V and version string printed + 3 command line error + 4 bash version is < 4.2 + 5 YYYY is not a year directory + 6 subst.year-navbar.awk tool or pandoc wrapper not found + 7 cannot find a non-empty or read .year file + 8 .year file under year YYYY is not a non-empty readable file + >= 10 < 210 ((not used)) + >= 210 internal tool error + +$NAME version: $VERSION" + +# setup +# +export NOOP= +export DO_NOT_PROCESS= + +# parse command line +# +while getopts :hv:Vd:D:nNt:T:u:w: flag; do + case "$flag" in + h) echo "$USAGE" 1>&2 + exit 2 + ;; + v) V_FLAG="$OPTARG" + ;; + V) echo "$VERSION" + exit 2 + ;; + d) TOPDIR="$OPTARG" + ;; + D) # parse -D docroot/ + case "$OPTARG" in + */) ;; + *) echo "$0: ERROR: in -D docroot/, the docroot must end in /" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + esac + DOCROOT_SLASH="$OPTARG" + TOOL_OPTION+=("-D") + TOOL_OPTION+=("$DOCROOT_SLASH") + ;; + n) NOOP="-n" + ;; + N) DO_NOT_PROCESS="-N" + ;; + t) # parse -t tagline + case "$OPTARG" in + *"'"*) + echo "$0: ERROR: in -t tagline, the tagline may not contain a single-quote character: $OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + *'"'*) + echo "$0: ERROR: in -t tagline, the tagline may not contain a double-quote character: $OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + *) ;; + esac + TAGLINE="$OPTARG" + TOOL_OPTION+=("-t") + TOOL_OPTION+=("$TAGLINE") + ;; + T) MD2HTML_SH="$OPTARG" + TOOL_OPTION+=("-T") + TOOL_OPTION+=("$MD2HTML_SH") + ;; + u) REPO_URL="$OPTARG" + TOOL_OPTION+=("-u") + TOOL_OPTION+=("$REPO_URL") + ;; + w) SITE_URL="$OPTARG" + TOOL_OPTION+=("-w") + TOOL_OPTION+=("$SITE_URL") + ;; + \?) echo "$0: ERROR: invalid option: -$OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + :) echo "$0: ERROR: option -$OPTARG requires an argument" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + *) echo "$0: ERROR: unexpected value from getopts: $flag" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + esac +done + +# parse the command line arguments +# +if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: debug level: $V_FLAG" 1>&2 +fi +# +shift $(( OPTIND - 1 )); +# +# verify arg count and parse args +# +export YYYY +case "$#" in +0) echo "$0: ERROR: expected 1 or more args, found: $#" 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; +1) YYYY="$1" + ;; +*) YYYY="$1" + shift + while [[ $# -gt 0 ]]; do + TOOL_OPTION+=("$1") + shift + done + ;; +esac +# +if [[ -z $YYYY ]]; then + echo "$0: ERROR: YYYY arg is empty" 1>&2 + echo "$USAGE" 1>&2 + exit 3 +fi + +# verify that we have a topdir directory +# +REPO_NAME=$(basename "$REPO_URL") +export REPO_NAME +if [[ -z $TOPDIR ]]; then + echo "$0: ERROR: cannot find top of git repo directory" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 211 +fi +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR does not exist: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 212 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR is not a directory: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 213 +fi + +# cd to topdir +# +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to non-existent path: $TOPDIR" 1>&2 + exit 217 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to a non-directory: $TOPDIR" 1>&2 + exit 218 +fi +export CD_FAILED +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: about to: cd $TOPDIR" 1>&2 +fi +cd "$TOPDIR" || CD_FAILED="true" +if [[ -n $CD_FAILED ]]; then + echo "$0: ERROR: cd $TOPDIR failed" 1>&2 + exit 219 +fi +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2 +fi + +# verify that YYYY is a entry directory +# +if [[ ! -d $YYYY ]]; then + echo "$0: ERROR: arg is not a directory: $YYYY" 1>&2 + exit 5 +fi +if [[ ! -r $YYYY ]]; then + echo "$0: ERROR: arg is not a writable directory: $YYYY" 1>&2 + exit 5 +fi + +# verify that YYYY has a non-empty readable .year file +# +export YEAR_FILE="$YYYY/.year" +if [[ ! -e $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year does not exist: $YEAR_FILE" 1>&2 + exit 7 +fi +if [[ ! -f $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not a regular file: $YEAR_FILE" 1>&2 + exit 7 +fi +if [[ ! -r $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not an readable file: $YEAR_FILE" 1>&2 + exit 7 +fi +if [[ ! -s $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not a non-empty readable file: $YEAR_FILE" 1>&2 + exit 7 +fi + +# verify that YYYY/README.md is a non-empty readable file +# +export README_FILE="$YYYY/README.md" +if [[ ! -e $README_FILE ]]; then + echo "$0: ERROR: year $YYYY README.md does not exist: $README_FILE" 1>&2 + exit 8 +fi +if [[ ! -f $README_FILE ]]; then + echo "$0: ERROR: year $YYYY README.md is not a file: $README_FILE" 1>&2 + exit 8 +fi +if [[ ! -r $README_FILE ]]; then + echo "$0: ERROR: year $YYYY README.md is not a readable file: $README_FILE" 1>&2 + exit 8 +fi +if [[ ! -s $README_FILE ]]; then + echo "$0: ERROR: year $YYYY README.md is not a non-empty readable file: $README_FILE" 1>&2 + exit 8 +fi + +# verify that the md2html.sh is executable +# +if [[ ! -e $MD2HTML_SH ]]; then + echo "$0: ERROR: md2html.sh does not exist: $MD2HTML_SH" 1>&2 + exit 5 +fi +if [[ ! -f $MD2HTML_SH ]]; then + echo "$0: ERROR: md2html.sh is not a regular file: $MD2HTML_SH" 1>&2 + exit 5 +fi +if [[ ! -x $MD2HTML_SH ]]; then + echo "$0: ERROR: md2html.sh is not an executable file: $MD2HTML_SH" 1>&2 + exit 5 +fi + +# parameter debugging +# +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 + echo "$0: debug[3]: NAME=$NAME" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 + echo "$0: debug[3]: TAGLINE=$TAGLINE" 1>&2 + echo "$0: debug[3]: MD2HTML_SH=$MD2HTML_SH" 1>&2 + echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 + echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: YYYY=$YYYY" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 + for index in "${!TOOL_OPTION[@]}"; do + echo "$0: debug[3]: TOOL_OPTION[$index]=${TOOL_OPTION[$index]}" 1>&2 + done + echo "$0: debug[3]: YEAR_FILE=$YEAR_FILE" 1>&2 + echo "$0: debug[3]: README_FILE=$README_FILE" 1>&2 +fi + +# If -N, time to exit +# +if [[ -n $DO_NOT_PROCESS ]]; then + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: arguments parsed, -N given, exit 0" 1>&2 + fi + exit 0 +fi + +# form the YYYY index.html unless -n +# +if [[ -z $NOOP ]]; then + + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: about to run: $MD2HTML_SH ${TOOL_OPTION[*]} -- $YYYY/README.md $YYYY/index.html" 1>&2 + fi + "$MD2HTML_SH" "${TOOL_OPTION[@]}" -- "$YYYY/README.md" "$YYYY/index.html" + status="$?" + if [[ $status -ne 0 ]]; then + echo "$0: ERROR: tool: $MD2HTML_SH ${TOOL_OPTION[*]} -- $YYYY/README.md $YYYY/index.html failed, error: $status" 1>&2 + exit 1 + fi + +# report disabled by -n +# +elif [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: because of -n, did not run: $MD2HTML_SH ${TOOL_OPTION[*]} -- $YYYY/README.md $YYYY/index.html" 1>&2 +fi + +# All Done!!! -- Jessica Noll, Age 2 +# +exit 0 diff --git a/bin/gen-years.sh b/bin/gen-years.sh index da2dbeb90..8c5d413f6 100755 --- a/bin/gen-years.sh +++ b/bin/gen-years.sh @@ -64,6 +64,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR TAC_TOOL=$(type -P tac) export TAC_TOOL if [[ ! -x $TAC_TOOL ]]; then @@ -480,6 +481,7 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: NAME=$NAME" 1>&2 echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 echo "$0: debug[3]: TAC_TOOL=$TAC_TOOL" 1>&2 echo "$0: debug[3]: FMT_TOOL=$FMT_TOOL" 1>&2 echo "$0: debug[3]: TAGLINE=$TAGLINE" 1>&2 @@ -487,17 +489,17 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 - echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 - echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 - echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2 - echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: NOOP=$NOOP" 1>&2 echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 echo "$0: debug[3]: EXIT_CODE=$EXIT_CODE" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 for index in "${!TOOL_OPTION[@]}"; do echo "$0: debug[3]: TOOL_OPTION[$index]=${TOOL_OPTION[$index]}" 1>&2 done - echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 + echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 + echo "$0: debug[3]: BIN_DIR=$BIN_DIR" 1>&2 + echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2 + echo "$0: debug[3]: YEARS_HTML=$YEARS_HTML" 1>&2 fi # -N stops early before any processing is performed diff --git a/bin/md2html.sh b/bin/md2html.sh index a306d29f5..d239070d2 100755 --- a/bin/md2html.sh +++ b/bin/md2html.sh @@ -122,6 +122,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="./" export PANDOC_WRAPPER="bin/pandoc-wrapper.sh" export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" @@ -673,25 +674,32 @@ function debug_parameters # print values that could be modified by parse_command_line # - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: NOOP=$NOOP" 1>&2 - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: VERSION=$VERSION" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: NAME=$NAME" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: GIT_TOOL=$GIT_TOOL" 1>&2 echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: TOPDIR=$TOPDIR" 1>&2 - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: MD2HTML_CFG=$MD2HTML_CFG" 1>&2 - for index in "${!PHASE_NAME[@]}"; do - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: phase name $index: ${PHASE_NAME[$index]}" - done 1>&2 - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: TAGLINE=$TAGLINE" 1>&2 - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: BEFORE_TOOL=$BEFORE_TOOL" 1>&2 echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: AFTER_TOOL=$AFTER_TOOL" 1>&2 - for index in "${!TOKEN[@]}"; do - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: token $index to be replaced with: ${TOKEN[$index]}" - done 1>&2 - echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: CAP_S_FLAG=$CAP_S_FLAG" 1>&2 echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: REPO_URL=$REPO_URL" 1>&2 echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: SITE_URL=$SITE_URL" 1>&2 echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: URL=$URL" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: NOOP=$NOOP" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: MD2HTML_CFG=$MD2HTML_CFG" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: TAGLINE=$TAGLINE" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: BEFORE_TOOL=$BEFORE_TOOL" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: AFTER_TOOL=$AFTER_TOOL" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: WORKING_DIR=$WORKING_DIR" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: REPO_NAME=$REPO_NAME" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: INC_PATH=$INC_PATH" 1>&2 + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: TOP=$TOP" 1>&2 + for index in "${!PHASE_NAME[@]}"; do + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: phase name $index: ${PHASE_NAME[$index]}" + done 1>&2 + for index in "${!TOKEN[@]}"; do + echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: token $index to be replaced with: ${TOKEN[$index]}" + done 1>&2 for index in "${!OUTPUT_TOOL[@]}"; do echo "$0: debug[$DEBUG_LEVEL]: $DBG_PREFIX: OUTPUT_TOOL[$index]=${OUTPUT_TOOL[$index]}" done 1>&2 diff --git a/bin/output-index-author.sh b/bin/output-index-author.sh index b07ffdb0c..6f6283120 100755 --- a/bin/output-index-author.sh +++ b/bin/output-index-author.sh @@ -70,6 +70,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="../../" export PANDOC_WRAPPER="bin/pandoc-wrapper.sh" export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" @@ -568,28 +569,32 @@ fi # parameter debugging # if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 echo "$0: debug[3]: NAME=$NAME" 1>&2 - echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 - echo "$0: debug[3]: ENTRY_DIR=$ENTRY_DIR" 1>&2 - echo "$0: debug[3]: ENTRY_ID=$ENTRY_ID" 1>&2 - echo "$0: debug[3]: DOT_YEAR=$DOT_YEAR" 1>&2 - echo "$0: debug[3]: DOT_PATH=$DOT_PATH" 1>&2 - echo "$0: debug[3]: ENTRY_JSON=$ENTRY_JSON" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 + echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 - echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 - echo "$0: debug[3]: URL=$URL" 1>&2 echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 + echo "$0: debug[3]: URL=$URL" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: ENTRY_PATH=$ENTRY_PATH" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 echo "$0: debug[3]: INC_PATH=$INC_PATH" 1>&2 echo "$0: debug[3]: INC_DIR=$INC_DIR" 1>&2 echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 echo "$0: debug[3]: BIN_DIR=$BIN_DIR" 1>&2 - echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 - echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 - echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 - echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 - echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 + echo "$0: debug[3]: ENTRY_DIR=$ENTRY_DIR" 1>&2 + echo "$0: debug[3]: ENTRY_ID=$ENTRY_ID" 1>&2 + echo "$0: debug[3]: DOT_YEAR=$DOT_YEAR" 1>&2 + echo "$0: debug[3]: DOT_PATH=$DOT_PATH" 1>&2 + echo "$0: debug[3]: ENTRY_JSON=$ENTRY_JSON" 1>&2 fi # Set AUTHOR_HANDLE_SET with author handles from .entry.json diff --git a/bin/output-index-inventory.sh b/bin/output-index-inventory.sh index 979a231fb..b86c82002 100755 --- a/bin/output-index-inventory.sh +++ b/bin/output-index-inventory.sh @@ -70,6 +70,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export PANDOC_WRAPPER="bin/pandoc-wrapper.sh" export DOCROOT_SLASH="../../" export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" @@ -388,28 +389,34 @@ fi # parameter debugging # if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 echo "$0: debug[3]: NAME=$NAME" 1>&2 - echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 - echo "$0: debug[3]: ENTRY_DIR=$ENTRY_DIR" 1>&2 - echo "$0: debug[3]: ENTRY_ID=$ENTRY_ID" 1>&2 - echo "$0: debug[3]: DOT_YEAR=$DOT_YEAR" 1>&2 - echo "$0: debug[3]: DOT_PATH=$DOT_PATH" 1>&2 - echo "$0: debug[3]: ENTRY_JSON=$ENTRY_JSON" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 - echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 - echo "$0: debug[3]: URL=$URL" 1>&2 echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 + echo "$0: debug[3]: URL=$URL" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: ENTRY_PATH=$ENTRY_PATH" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 echo "$0: debug[3]: INC_PATH=$INC_PATH" 1>&2 echo "$0: debug[3]: INC_DIR=$INC_DIR" 1>&2 echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 echo "$0: debug[3]: BIN_DIR=$BIN_DIR" 1>&2 - echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 + echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 + echo "$0: debug[3]: ENTRY_DIR=$ENTRY_DIR" 1>&2 + echo "$0: debug[3]: ENTRY_ID=$ENTRY_ID" 1>&2 + echo "$0: debug[3]: DOT_YEAR=$DOT_YEAR" 1>&2 + echo "$0: debug[3]: YYYY_DIR=$YYYY_DIR" 1>&2 + echo "$0: debug[3]: DOT_PATH=$DOT_PATH" 1>&2 + echo "$0: debug[3]: ENTRY_JSON=$ENTRY_JSON" 1>&2 echo "$0: debug[3]: MANIFEST_ENTRY_JSON_AWK=$MANIFEST_ENTRY_JSON_AWK" 1>&2 - echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 - echo "$0: debug[3]: NOOP=$NOOP" 1>&2 fi # If -N, time to exit diff --git a/bin/output-year-index.sh b/bin/output-year-index.sh new file mode 100755 index 000000000..ace9b74bc --- /dev/null +++ b/bin/output-year-index.sh @@ -0,0 +1,655 @@ +#!/usr/bin/env bash +# +# output-year-index.sh - output markdown of winner links for a given year +# +# This tool is used in conjunction with the inc/md2html.cfg configuration +# file, and the tools that use that use that configuration file such as "bin/md2html.sh". +# +# It is usually invoked by: +# +# -a bin/output-year-index.sh +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# +# Permission to use, copy, modify, and distribute this software and +# its documentation for any purpose and without fee is hereby granted, +# provided that the above copyright, this permission notice and text +# this comment, and the disclaimer below appear in all of the following: +# +# supporting documentation +# source copies +# source works derived from this source +# binaries derived from this source or from derived source +# +# LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, +# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO +# EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR +# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF +# USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +# PERFORMANCE OF THIS SOFTWARE. +# +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# Share and enjoy! :-) + +# firewall - must be bash with a version 4.2 or later +# +# We must declare arrays with -ag or -Ag, and we need loops to "export" modified variables. +# +if [[ -z ${BASH_VERSINFO[0]} || ${BASH_VERSINFO[0]} -lt 4 || ${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 2 ]]; then + echo "$0: ERROR: bash version must be >= 4.2: $BASH_VERSION" 1>&2 + exit 4 +fi + +# setup bash file matching +# +# Requires bash with a version 4.2 or later +# +shopt -s nullglob # enable expanded to nothing rather than remaining unexpanded +shopt -u failglob # disable error message if no matches are found +shopt -u dotglob # disable matching files starting with . +shopt -s globskipdots # enable never matching . or .. +shopt -u nocaseglob # disable strict case matching +shopt -u extglob # enable extended globbing patterns +shopt -s globstar # enable ** to match all files and zero or more directories and subdirectories + +# set variables referenced in the usage message +# +export VERSION="1.0 2024-02-12" +NAME=$(basename "$0") +export NAME +export V_FLAG=0 +GIT_TOOL=$(type -P git) +export GIT_TOOL +if [[ -z "$GIT_TOOL" ]]; then + echo "$0: FATAL: git tool is not installed or not in \$PATH" 1>&2 + exit 210 +fi +"$GIT_TOOL" rev-parse --is-inside-work-tree >/dev/null 2>&1 +status="$?" +if [[ $status -eq 0 ]]; then + TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) +fi +export TOPDIR +export DOCROOT_SLASH="../../" +export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" +export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc" + +# set usage message +# +export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-n] [-N] + [-p tool] [-u repo_url] [-U URL] [-w site_url] [-e string ..] [-E exitcode] + YYYY [more_options] + + -h print help message and exit + -v level set verbosity level (def level: 0) + -V print version string and exit + + -d topdir set topdir (def: $TOPDIR) + -D docroot/ set the document root path followed by slash (def: $DOCROOT_SLASH) + NOTE: 'docroot' must end in a slash + + -n go thru the actions, but do not update any files (def: do the action) + -N do not process file, just parse arguments and ignore the file (def: process the file) + + -p tool run 'pandoc wrapper tool' (not pandoc path) during HTML phase number 21 (def: use $PANDOC_WRAPPER) + + -u repo_url Base level URL of target git repo (def: $REPO_URL) + -U url URL of HTML file being formed (def: $URL) + -w site_url Base URL of the web site (def: $SITE_URL) + + -e string output string, followed by newline, to stderr (def: do not) + -E exitcode force exit with exitcode (def: exit based on success or failure of the action) + + YYYY path from topdir to year directory: must contain the files: README.md, .path and .entry.json + [more_options] additional tool command line options to use before the YYYY/dir argument + +Exit codes: + 0 all OK + 2 -h and help string printed or -V and version string printed + 3 command line error + 4 bash version is < 4.2 + 5 YYYY is not a year directory + 6 subst.year-navbar.awk tool or pandoc wrapper not found + 7 cannot find a non-empty or read .year file + 8 entry under year YYYY is not in proper form + >= 10 < 210 ((not used)) + >= 210 internal tool error + +$NAME version: $VERSION" + +# output_award +# +# Write the award name to standard output (stdout) +# +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - until we have the jnamval command, we must FAKE PARSE the .entry.json file - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# +# usage: +# output_award YYYY/dir/.entry.json +# +# returns: +# 0 ==> no errors detected, but output may be empty +# > 0 ==> function error number +# +function output_award +{ + local ENTRY_JSON_PATH; # the .entry.json path + + # parse args + # + if [[ $# -ne 1 ]]; then + echo "$0: ERROR: in output_award: expected 1 arg, found $#" 1>&2 + return 1 + fi + ENTRY_JSON_PATH="$1" + if [[ ! -e $ENTRY_JSON_PATH ]]; then + echo "$0: ERROR: in output_award: .entry.json does not exist: $ENTRY_JSON_PATH" 1>&2 + return 2 + fi + if [[ ! -f $ENTRY_JSON_PATH ]]; then + echo "$0: ERROR: in output_award: .entry.json is not a file: $ENTRY_JSON_PATH" 1>&2 + return 3 + fi + if [[ ! -r $ENTRY_JSON_PATH ]]; then + echo "$0: ERROR: in output_award: .entry.json is not a readable file: $ENTRY_JSON_PATH" 1>&2 + return 4 + fi + + # obtain the award string + # + AWARD=$(grep -F '"award" : "' "$ENTRY_JSON_PATH" | sed -e 's/^.*"award" : "//' -e 's/",//') + if [[ -z $AWARD ]]; then + echo "$0: ERROR: in output_award: no award found in .entry.json file: $ENTRY_JSON_PATH" 1>&2 + return 5 + fi + echo "$AWARD" + return 0 +} + +# output_ordinal +# +# Write the numerical ordinal form of a non-negative integer to standard output (stdout) +# +# usage: +# output_ordinal integer +# +# returns: +# 0 ==> no errors detected +# > 0 ==> function error number +# +function output_ordinal +{ + local INTEGER; # integer argument + + # parse args + # + if [[ $# -ne 1 ]]; then + echo "$0: ERROR: in output_ordinal: expected 1 arg, found $#" 1>&2 + return 1 + fi + INTEGER="$1" + if [[ $INTEGER =~ ^-?[0-9]+$ ]]; then + : + else + echo "$0: ERROR: argument is not an integer: $INTEGER" 1>&2 + return 2 + fi + if [[ $INTEGER -lt 0 ]]; then + echo "$0: ERROR: integer is negative: $INTEGER" 1>&2 + return 3 + fi + + # case: 11, 12, 13 are N-th + # + if [[ $INTEGER -ge 11 && $INTEGER -le 13 ]]; then + echo "${INTEGER}th" + + # case: 1 mod 10 is N-st + # + elif [[ $((INTEGER % 10)) -eq 1 ]]; then + echo "${INTEGER}st" + + # case: 2 mod 10 is N-nd + # + elif [[ $((INTEGER % 10)) -eq 2 ]]; then + echo "${INTEGER}nd" + + # case: 3 mod 10 is N-rd + # + elif [[ $((INTEGER % 10)) -eq 3 ]]; then + echo "${INTEGER}rd" + + # case: everything else is N-th + # + else + echo "${INTEGER}th" + fi + return 0 +} + +# setup +# +export NOOP= +export DO_NOT_PROCESS= + +# parse command line +# +while getopts :hv:Vd:D:nNp:u:U:w:e:E: flag; do + case "$flag" in + h) echo "$USAGE" 1>&2 + exit 2 + ;; + v) V_FLAG="$OPTARG" + ;; + V) echo "$VERSION" + exit 2 + ;; + d) TOPDIR="$OPTARG" + ;; + D) # parse -D docroot/ + case "$OPTARG" in + */) ;; + *) echo "$0: ERROR: in -D docroot/, the docroot must end in /" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + esac + DOCROOT_SLASH="$OPTARG" + ;; + n) NOOP="-n" + ;; + N) DO_NOT_PROCESS="-N" + ;; + p) PANDOC_WRAPPER="$OPTARG" + ;; + u) REPO_URL="$OPTARG" + ;; + U) URL="$OPTARG" + ;; + w) SITE_URL="$OPTARG" + ;; + e) echo "$OPTARG" 1>&2 + ;; + E) exit "$OPTARG" + ;; + \?) echo "$0: ERROR: invalid option: -$OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + :) echo "$0: ERROR: option -$OPTARG requires an argument" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + *) echo "$0: ERROR: unexpected value from getopts: $flag" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + esac +done + +# parse the command line arguments +# +if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: debug level: $V_FLAG" 1>&2 +fi +# +shift $(( OPTIND - 1 )); +# +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: file argument count: $#" 1>&2 +fi +if [[ $# -ne 1 ]]; then + echo "$0: ERROR: expected 1 arg, found: $#" 1>&2 + exit 3 +fi +# +export YYYY="$1" +if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: YYYY=$YYYY" 1>&2 +fi +if [[ -z $YYYY ]]; then + echo "$0: ERROR: YYYY arg is empty" 1>&2 + exit 3 +fi + +# verify that we have a topdir directory +# +REPO_NAME=$(basename "$REPO_URL") +export REPO_NAME +if [[ -z $TOPDIR ]]; then + echo "$0: ERROR: cannot find top of git repo directory" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 211 +fi +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR does not exist: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 212 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR is not a directory: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 213 +fi + +# cd to topdir +# +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to non-existent path: $TOPDIR" 1>&2 + exit 217 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to a non-directory: $TOPDIR" 1>&2 + exit 218 +fi +export CD_FAILED +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: about to: cd $TOPDIR" 1>&2 +fi +cd "$TOPDIR" || CD_FAILED="true" +if [[ -n $CD_FAILED ]]; then + echo "$0: ERROR: cd $TOPDIR failed" 1>&2 + exit 219 +fi +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2 +fi + +# verify we have the pandoc wrapper +# +if [[ ! -e $PANDOC_WRAPPER ]]; then + echo "$0: ERROR: pandoc wrapper tool does not exist: $PANDOC_WRAPPER" 1>&2 + exit 6 +fi +if [[ ! -f $PANDOC_WRAPPER ]]; then + echo "$0: ERROR: pandoc wrapper tool is not a file: $PANDOC_WRAPPER" 1>&2 + exit 6 +fi +if [[ ! -x $PANDOC_WRAPPER ]]; then + echo "$0: ERROR: pandoc wrapper tool is not an executable file: $PANDOC_WRAPPER" 1>&2 + exit 6 +fi + +# verify that YYYY is a entry directory +# +if [[ ! -d $YYYY ]]; then + echo "$0: ERROR: arg is not a directory: $YYYY" 1>&2 + exit 5 +fi +if [[ ! -r $YYYY ]]; then + echo "$0: ERROR: arg is not a writable directory: $YYYY" 1>&2 + exit 5 +fi + +# verify we have a non-empty readable .top file +# +export TOP_FILE=".top" +if [[ ! -e $TOP_FILE ]]; then + echo "$0: ERROR: .top does not exist: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -f $TOP_FILE ]]; then + echo "$0: ERROR: .top is not a regular file: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -r $TOP_FILE ]]; then + echo "$0: ERROR: .top is not an readable file: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -s $TOP_FILE ]]; then + echo "$0: ERROR: .top is not a non-empty readable file: $TOP_FILE" 1>&2 + exit 6 +fi + +# verify that YYYY has a non-empty readable .year file +# +export YEAR_FILE="$YYYY/.year" +if [[ ! -e $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year does not exist: $YEAR_FILE" 1>&2 + exit 7 +fi +if [[ ! -f $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not a regular file: $YEAR_FILE" 1>&2 + exit 7 +fi +if [[ ! -r $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not an readable file: $YEAR_FILE" 1>&2 + exit 7 +fi +if [[ ! -s $YEAR_FILE ]]; then + echo "$0: ERROR: YYYY/.year is not a non-empty readable file: $YEAR_FILE" 1>&2 + exit 7 +fi + +# determine The N-th IOCCC string +# +LINE_NUM=$(sed -n "/$YYYY/=" "$TOP_FILE" | head -1) +if [[ -z $LINE_NUM ]]; then + echo "$0: ERROR: cannot determine line number in $TOP_FILE for year: $YYYY" 1>&2 + exit 220 +fi +ORDINAL=$(output_ordinal "$LINE_NUM") +export ORDINAL +if [[ -z $ORDINAL ]]; then + echo "$0: ERROR: cannot determine ordinal for: $LINE_NUM" 1>&2 + exit 221 +fi + +# parameter debugging +# +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 + echo "$0: debug[3]: NAME=$NAME" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 + echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 + echo "$0: debug[3]: URL=$URL" 1>&2 + echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: YYYY=$YYYY" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 + echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2 + echo "$0: debug[3]: YEAR_FILE=$YEAR_FILE" 1>&2 + echo "$0: debug[3]: LINE_NUM=$LINE_NUM" 1>&2 + echo "$0: debug[3]: ORDINAL=$ORDINAL" 1>&2 +fi + +# If -N, time to exit +# +if [[ -n $DO_NOT_PROCESS ]]; then + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: arguments parsed, -N given, exit 0" 1>&2 + fi + exit 0 +fi + +# create a temporary markdown for pandoc to process +# +TMP_FILE=".$NAME.$$.md" +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: temporary markdown file: $TMP_FILE" 1>&2 +fi +if [[ -z $NOOP ]]; then + trap 'rm -f $TMP_FILE; exit' 0 1 2 3 15 + rm -f "$TMP_FILE" + if [[ -e $TMP_FILE ]]; then + echo "$0: ERROR: cannot remove temporary markdown file: $TMP_FILE" 1>&2 + exit 227 + fi + :> "$TMP_FILE" + if [[ ! -e $TMP_FILE ]]; then + echo "$0: ERROR: cannot create temporary markdown file: $TMP_FILE" 1>&2 + exit 228 + fi +elif [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: because of -n, temporary markdown file is not used: $TMP_FILE" 1>&2 +fi + +# output leading markdown for this IOCCC year +# +{ + echo "# Winning Entries of $YYYY - The $ORDINAL IOCCC" + echo + echo "**Download IOCCC** [$YYYY entry source]($YYYY/ioccc.$YYYY.tar.bz2)" + echo +} | if [[ -z $NOOP ]]; then + cat >> "$TMP_FILE" +else + cat > /dev/null + if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: because of -n, IOCCC year $YYYY starting markdown not written to stdout" 1>&2 + fi +fi + +# process each entry under YYYY +# +export YYYY_DIR +for YYYY_DIR in $(< "$YEAR_FILE"); do + + # debug YYYY + # + if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: starting to process year/dir: $YYYY_DIR" 1>&2 + fi + + # parse YYYY_DIR + # + if [[ ! -d $YYYY_DIR ]]; then + echo "$0: ERROR: YYYY_DIR is not a directory: $YYYY_DIR" 1>&2 + exit 8 + fi + if [[ ! -w $YYYY_DIR ]]; then + echo "$0: ERROR: YYYY_DIR is not a writable directory: $YYYY_DIR" 1>&2 + exit 8 + fi + export YEAR_DIR=${YYYY_DIR%%/*} + if [[ -z $YEAR_DIR ]]; then + echo "$0: ERROR: YYYY_DIR not in YYYY/dir form: $YYYY_DIR" 1>&2 + exit 8 + fi + export ENTRY_DIR=${YYYY_DIR#*/} + if [[ -z $ENTRY_DIR ]]; then + echo "$0: ERROR: YYYY_DIR not in $YEAR_DIR/dir form: $YYYY_DIR" 1>&2 + exit 8 + fi + if [[ $ENTRY_DIR = */* ]]; then + echo "$0: ERROR: YYYY_DIR: $YYYY_DIR dir contains a /: $ENTRY_DIR" 1>&2 + exit 8 + fi + + # verify that YYYY_DIR is a writable directory + # + if [[ ! -e $YYYY_DIR ]]; then + echo "$0: ERROR: YYYY_DIR does not exist: $YYYY_DIR" 1>&2 + exit 8 + fi + if [[ ! -d $YYYY_DIR ]]; then + echo "$0: ERROR: YYYY_DIR is not a directory: $YYYY_DIR" 1>&2 + exit 8 + fi + if [[ ! -w $YYYY_DIR ]]; then + echo "$0: ERROR: YYYY_DIR is not an writable directory: $YYYY_DIR" 1>&2 + exit 8 + fi + + # verify YYYY/dir/.path + # + export DOT_PATH="$YYYY_DIR/.path" + if [[ ! -s $DOT_PATH ]]; then + echo "$0: ERROR: not a non-empty file: $DOT_PATH" 1>&2 + exit 8 + fi + DOT_PATH_CONTENT=$(< "$DOT_PATH") + if [[ $YYYY_DIR != "$DOT_PATH_CONTENT" ]]; then + echo "$0: ERROR: arg: $YYYY_DIR does not match $DOT_PATH contents: $DOT_PATH_CONTENT" 1>&2 + exit 8 + fi + export ENTRY_JSON="$YYYY_DIR/.entry.json" + if [[ ! -e $ENTRY_JSON ]]; then + echo "$0: ERROR: .entry.json does not exist: $ENTRY_JSON" 1>&2 + exit 8 + fi + if [[ ! -f $ENTRY_JSON ]]; then + echo "$0: ERROR: .entry.json is not a file: $ENTRY_JSON" 1>&2 + exit 8 + fi + if [[ ! -r $ENTRY_JSON ]]; then + echo "$0: ERROR: .entry.json is not a readable file: $ENTRY_JSON" 1>&2 + exit 8 + fi + + # determine the award for this entry + # + AWARD=$(output_award "$ENTRY_JSON") + if [[ -z $AWARD ]]; then + echo "$0: ERROR: cannot find award in .entry.json: $ENTRY_JSON" 1>&2 + exit 8 + fi + + # output markdown for this entry + # + echo "* [$YYYY_DIR]($YYYY_DIR/index.html) - $AWARD" +done | if [[ -z $NOOP ]]; then + cat >> "$TMP_FILE" +else + cat > /dev/null + if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: because of -n, $YYYY entry markdown data is NOT written to stdout" 1>&2 + fi +fi + +# write trailing markdown for this IOCCC year +# +{ + echo + echo ' **Jump to:** [top](#)' + echo +} | if [[ -z $NOOP ]]; then + cat >> "$TMP_FILE" +else + cat > /dev/null + if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: because of -n, IOCCC year $YYYY ending markdown data is NOT to stdout" 1>&2 + fi +fi + +# convert temporary markdown file into HTML +# +if [[ -z $NOOP ]]; then + echo "" + echo + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: about to execute: $PANDOC_WRAPPER $TMP_FILE -" 1>&2 + fi + "$PANDOC_WRAPPER" "$TMP_FILE" - + status="$?" + if [[ $status -ne 0 ]]; then + echo "$0: ERROR: pandoc failed, error: $status" 1>&2 + exit 231 + fi + echo + echo "" +elif [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: -n disabled execution of: $PANDOC_WRAPPER $TMP_FILE -" 1>&2 +fi + +# All Done!!! -- Jessica Noll, Age 2 +# +if [[ -z $NOOP ]]; then + rm -f "$TMP_FILE" +elif [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: -n disabled execution of: rm -f $TMP_FILE" 1>&2 +fi +exit 0 diff --git a/bin/pandoc-wrapper.sh b/bin/pandoc-wrapper.sh index 1e5e31f0b..0b1e15861 100755 --- a/bin/pandoc-wrapper.sh +++ b/bin/pandoc-wrapper.sh @@ -72,6 +72,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR PANDOC_TOOL=$(type -P pandoc) if [[ -z $PANDOC_TOOL ]]; then PANDOC_TOOL="/opt/homebrew/bin/pandoc" @@ -290,17 +291,24 @@ fi # parameter debugging # if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 echo "$0: debug[3]: NAME=$NAME" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: PANDOC_TOOL=$PANDOC_TOOL" 1>&2 + echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 - echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: MARKDOWN_INPUT=$MARKDOWN_INPUT" 1>&2 + echo "$0: debug[3]: HTML_OUTPUT=$HTML_OUTPUT" 1>&2 echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 echo "$0: debug[3]: INC_PATH=$INC_PATH" 1>&2 echo "$0: debug[3]: INC_DIR=$INC_DIR" 1>&2 echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 echo "$0: debug[3]: BIN_DIR=$BIN_DIR" 1>&2 - echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 - echo "$0: debug[3]: NOOP=$NOOP" 1>&2 fi # If -N, time to exit diff --git a/bin/quick-readme2index.sh b/bin/quick-readme2index.sh index a5590ce8a..71f467c41 100755 --- a/bin/quick-readme2index.sh +++ b/bin/quick-readme2index.sh @@ -73,6 +73,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="../../" # We use the tagline of "bin/readme2index.sh" instead of: # @@ -117,7 +118,6 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N] -N do not process anything, just parse arguments (def: process something) -t tagline string to write about the tool that formed the markdown content (def: $TAGLINE) - NOTE: 'pandoc_opts' may be enclosed within, but may NOT contain an internal single-quote or double-quote. -T md2html.sh run 'markdown to html tool' to convert markdown into HTML (def: $MD2HTML_SH) -p tool run 'pandoc wrapper tool' (not pandoc path) during HTML phase number 21 (def: use $PANDOC_WRAPPER) @@ -130,7 +130,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N] tool the tool to run over all entries [more_options] additional tool command line options to use before the YYYY/dir argument -NOTE: Any '-t tagline', '-T md2html.sh', '-p tool', '-P pandoc_opts', '-u repo_url', '-U top_url' +NOTE: Any '-t tagline', '-T md2html.sh', '-p tool', '-u repo_url', '-w site_url' are passed to the 'tool' at the beginning of the command line, and before any optional 'more_options' and before the final YYYY/dir argument. diff --git a/bin/readme2index.sh b/bin/readme2index.sh index 5762d1523..787e5ea79 100755 --- a/bin/readme2index.sh +++ b/bin/readme2index.sh @@ -67,6 +67,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="../../" export TAGLINE="bin/$NAME" export MD2HTML_SH="bin/md2html.sh" diff --git a/bin/sort.gitignore.sh b/bin/sort.gitignore.sh index 1c0a7e9ad..d692b95f4 100755 --- a/bin/sort.gitignore.sh +++ b/bin/sort.gitignore.sh @@ -79,6 +79,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" export TOP_URL="https://ioccc-src.github.io/temp-test-ioccc" export SGI_TOOL="bin/sgi.sh" @@ -309,13 +310,16 @@ fi # parameter debugging # if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 echo "$0: debug[3]: NAME=$NAME" 1>&2 - echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 echo "$0: debug[3]: TOP_URL=$TOP_URL" 1>&2 echo "$0: debug[3]: SGI_TOOL=$SGI_TOOL" 1>&2 - echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 echo "$0: debug[3]: ENTRY_PATH=$ENTRY_PATH" 1>&2 echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 diff --git a/bin/subst.default.sh b/bin/subst.default.sh index 8ada54dc3..b75ced2b6 100755 --- a/bin/subst.default.sh +++ b/bin/subst.default.sh @@ -73,6 +73,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="../../" export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc" @@ -189,15 +190,24 @@ if [[ $V_FLAG -ge 5 ]]; then echo "$0: debug[5]: file argument count: $#" 1>&2 fi +# form Nu Html Checker doc url string +# +VALIDATOR_ENCODED_URL=$(echo "$URL" | sed -e 's;/;%2F;g' -e 's;:;%3A;') + # parameter debugging # if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 echo "$0: debug[3]: NAME=$NAME" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 + echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 echo "$0: debug[3]: URL=$URL" 1>&2 echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: VALIDATOR_ENCODED_URL=$VALIDATOR_ENCODED_URL" 1>&2 fi # If -N, time to exit @@ -218,10 +228,6 @@ echo "HEADER_1=The International Obfuscated C Code Contest" # echo "-s" echo "DOCROOT_SLASH=$DOCROOT_SLASH" - -# form Nu Html Checker doc url string -# -VALIDATOR_ENCODED_URL=$(echo "$URL" | sed -e 's;/;%2F;g' -e 's;:;%3A;') export VALIDATOR_ENCODED_URL # output the Validator encoded URL diff --git a/bin/subst.entry-index.sh b/bin/subst.entry-index.sh index 39bf85123..44c4d90cc 100755 --- a/bin/subst.entry-index.sh +++ b/bin/subst.entry-index.sh @@ -73,6 +73,7 @@ status="$?" if [[ $status -eq 0 ]]; then TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) fi +export TOPDIR export DOCROOT_SLASH="../../" export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc" @@ -429,28 +430,32 @@ export AWARD # parameter debugging # if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 echo "$0: debug[3]: NAME=$NAME" 1>&2 - echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 - echo "$0: debug[3]: ENTRY_DIR=$ENTRY_DIR" 1>&2 - echo "$0: debug[3]: ENTRY_ID=$ENTRY_ID" 1>&2 - echo "$0: debug[3]: DOT_YEAR=$DOT_YEAR" 1>&2 - echo "$0: debug[3]: DOT_PATH=$DOT_PATH" 1>&2 - echo "$0: debug[3]: ENTRY_JSON=$ENTRY_JSON" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 - echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 echo "$0: debug[3]: URL=$URL" 1>&2 echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: ENTRY_PATH=$ENTRY_PATH" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 echo "$0: debug[3]: INC_PATH=$INC_PATH" 1>&2 echo "$0: debug[3]: INC_DIR=$INC_DIR" 1>&2 echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 echo "$0: debug[3]: BIN_DIR=$BIN_DIR" 1>&2 + echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 + echo "$0: debug[3]: ENTRY_DIR=$ENTRY_DIR" 1>&2 + echo "$0: debug[3]: ENTRY_ID=$ENTRY_ID" 1>&2 + echo "$0: debug[3]: DOT_YEAR=$DOT_YEAR" 1>&2 + echo "$0: debug[3]: YYYY_DIR=$YYYY_DIR" 1>&2 + echo "$0: debug[3]: DOT_PATH=$DOT_PATH" 1>&2 + echo "$0: debug[3]: ENTRY_JSON=$ENTRY_JSON" 1>&2 echo "$0: debug[3]: ENTRY_NAVBAR_AWK=$ENTRY_NAVBAR_AWK" 1>&2 - echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 - echo "$0: debug[3]: NOOP=$NOOP" 1>&2 fi # If -N, time to exit diff --git a/bin/subst.year-index.sh b/bin/subst.year-index.sh new file mode 100755 index 000000000..99e4a4964 --- /dev/null +++ b/bin/subst.year-index.sh @@ -0,0 +1,484 @@ +#!/usr/bin/env bash +# +# subst.year-index.sh - print substitutions for a year's index.html +# +# This tool is used in conjunction with the inc/md2html.cfg configuration +# file, and the tools that use that use that configuration file such as "bin/md2html.sh". +# +# It is usually invoked by: +# +# -o bin/subst.year-index.sh +# +# IMPORTANT: Each command line option / argument MUST be printed on a separate line! +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# +# Permission to use, copy, modify, and distribute this software and +# its documentation for any purpose and without fee is hereby granted, +# provided that the above copyright, this permission notice and text +# this comment, and the disclaimer below appear in all of the following: +# +# supporting documentation +# source copies +# source works derived from this source +# binaries derived from this source or from derived source +# +# LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, +# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO +# EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR +# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF +# USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +# PERFORMANCE OF THIS SOFTWARE. +# +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# Share and enjoy! :-) + +# firewall - must be bash with a version 4.2 or later +# +# We must declare arrays with -ag or -Ag, and we need loops to "export" modified variables. +# +if [[ -z ${BASH_VERSINFO[0]} || ${BASH_VERSINFO[0]} -lt 4 || ${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 2 ]]; then + echo "$0: ERROR: bash version must be >= 4.2: $BASH_VERSION" 1>&2 + exit 4 +fi + +# setup bash file matching +# +# Requires bash with a version 4.2 or later +# +shopt -s nullglob # enable expanded to nothing rather than remaining unexpanded +shopt -u failglob # disable error message if no matches are found +shopt -u dotglob # disable matching files starting with . +shopt -s globskipdots # enable never matching . or .. +shopt -u nocaseglob # disable strict case matching +shopt -u extglob # enable extended globbing patterns +shopt -s globstar # enable ** to match all files and zero or more directories and subdirectories + +# set variables referenced in the usage message +# +export VERSION="1.0 2024-02-11" +NAME=$(basename "$0") +export NAME +export V_FLAG=0 +GIT_TOOL=$(type -P git) +export GIT_TOOL +if [[ -z "$GIT_TOOL" ]]; then + echo "$0: FATAL: git tool is not installed or not in \$PATH" 1>&2 + exit 210 +fi +"$GIT_TOOL" rev-parse --is-inside-work-tree >/dev/null 2>&1 +status="$?" +if [[ $status -eq 0 ]]; then + TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) +fi +export TOPDIR +export DOCROOT_SLASH="../../" +export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" +export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc" + +# set usage message +# +export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-n] [-N] + [-u repo_url] [-U URL] [-w site_url] [-e string ..] [-E exitcode] + YYYY + + -h print help message and exit + -v level set verbosity level (def level: 0) + -V print version string and exit + + -d topdir set topdir (def: $TOPDIR) + -D docroot/ set the document root path followed by slash (def: $DOCROOT_SLASH) + NOTE: 'docroot' must end in a slash + + -n go thru the actions, but do not update any files (def: do the action) + -N do not process file, just parse arguments and ignore the file (def: process the file) + + -u repo_url Base level URL of target git repo (def: $REPO_URL) + -U url URL of HTML file being formed (def: $URL) + -w site_url Base URL of the web site (def: $SITE_URL) + + -e string output string, followed by newline, to stderr (def: do not) + -E exitcode force exit with exitcode (def: exit based on success or failure of the action) + + YYYY path from topdir to year directory: must contain the files: README.md, .path and .entry.json + +Exit codes: + 0 all OK + 1 pandoc exited non-zero + 2 -h and help string printed or -V and version string printed + 3 command line error + 4 bash version is < 4.2 + 5 YYYY is not a year directory + 6 subst.year-navbar.awk tool not found + 7 cannot find important information about the author or winning entry + >= 10 < 210 ((not used)) + >= 210 internal tool error + +$NAME version: $VERSION" + +# output_ordinal +# +# Write the numerical ordinal form of a non-negative integer to standard output (stdout) +# +# usage: +# output_ordinal integer +# +# returns: +# 0 ==> no errors detected +# > 0 ==> function error number +# +function output_ordinal +{ + local INTEGER; # integer argument + + # parse args + # + if [[ $# -ne 1 ]]; then + echo "$0: ERROR: in output_ordinal: expected 1 arg, found $#" 1>&2 + return 1 + fi + INTEGER="$1" + if [[ $INTEGER =~ ^-?[0-9]+$ ]]; then + : + else + echo "$0: ERROR: argument is not an integer: $INTEGER" 1>&2 + return 2 + fi + if [[ $INTEGER -lt 0 ]]; then + echo "$0: ERROR: integer is negative: $INTEGER" 1>&2 + return 3 + fi + + # case: 11, 12, 13 are N-th + # + if [[ $INTEGER -ge 11 && $INTEGER -le 13 ]]; then + echo "${INTEGER}th" + + # case: 1 mod 10 is N-st + # + elif [[ $((INTEGER % 10)) -eq 1 ]]; then + echo "${INTEGER}st" + + # case: 2 mod 10 is N-nd + # + elif [[ $((INTEGER % 10)) -eq 2 ]]; then + echo "${INTEGER}nd" + + # case: 3 mod 10 is N-rd + # + elif [[ $((INTEGER % 10)) -eq 3 ]]; then + echo "${INTEGER}rd" + + # case: everything else is N-th + # + else + echo "${INTEGER}th" + fi + return 0 +} + +# setup +# +export NOOP= +export DO_NOT_PROCESS= + +# parse command line +# +while getopts :hv:Vd:D:nNu:U:w:e:E: flag; do + case "$flag" in + h) echo "$USAGE" 1>&2 + exit 2 + ;; + v) V_FLAG="$OPTARG" + ;; + V) echo "$VERSION" + exit 2 + ;; + d) TOPDIR="$OPTARG" + ;; + D) # parse -D docroot/ + case "$OPTARG" in + */) ;; + *) echo "$0: ERROR: in -D docroot/, the docroot must end in /" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + esac + DOCROOT_SLASH="$OPTARG" + ;; + n) NOOP="-n" + ;; + N) DO_NOT_PROCESS="-N" + ;; + u) REPO_URL="$OPTARG" + ;; + U) URL="$OPTARG" + ;; + w) SITE_URL="$OPTARG" + ;; + e) echo "$OPTARG" 1>&2 + ;; + E) exit "$OPTARG" + ;; + \?) echo "$0: ERROR: invalid option: -$OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + :) echo "$0: ERROR: option -$OPTARG requires an argument" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + *) echo "$0: ERROR: unexpected value from getopts: $flag" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + esac +done + +# parse the command line arguments +# +if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: debug level: $V_FLAG" 1>&2 +fi +# +shift $(( OPTIND - 1 )); +# +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: file argument count: $#" 1>&2 +fi +if [[ $# -ne 1 ]]; then + echo "$0: ERROR: expected 1 arg, found: $#" 1>&2 + exit 3 +fi +# +export YEAR_ARG="$1" +if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: YEAR_ARG=$YEAR_ARG" 1>&2 +fi + +# verify that we have a topdir directory +# +REPO_NAME=$(basename "$REPO_URL") +export REPO_NAME +if [[ -z $TOPDIR ]]; then + echo "$0: ERROR: cannot find top of git repo directory" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 211 +fi +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR does not exist: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 212 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR is not a directory: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 213 +fi + +# verify that we have an author subdirectory +# +export AUTHOR_PATH="$TOPDIR/author" +if [[ ! -d $AUTHOR_PATH ]]; then + echo "$0: ERROR: author is not a directory under topdir: $AUTHOR_PATH" 1>&2 + exit 214 +fi +export AUTHOR_DIR="author" + +# verify that we have an inc subdirectory +# +export INC_PATH="$TOPDIR/inc" +if [[ ! -d $INC_PATH ]]; then + echo "$0: ERROR: inc is not a directory under topdir: $INC_PATH" 1>&2 + exit 215 +fi +export INC_DIR="inc" + +# verify that we have an bin subdirectory +# +export BIN_PATH="$TOPDIR/bin" +if [[ ! -d $BIN_PATH ]]; then + echo "$0: ERROR: bin is not a directory under topdir: $BIN_PATH" 1>&2 + exit 216 +fi +export BIN_DIR="bin" + +# cd to topdir +# +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to non-existent path: $TOPDIR" 1>&2 + exit 217 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to a non-directory: $TOPDIR" 1>&2 + exit 218 +fi +export CD_FAILED +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: about to: cd $TOPDIR" 1>&2 +fi +cd "$TOPDIR" || CD_FAILED="true" +if [[ -n $CD_FAILED ]]; then + echo "$0: ERROR: cd $TOPDIR failed" 1>&2 + exit 219 +fi +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2 +fi + +# verify that YEAR_ARG is a entry directory +# +# YEAR_ARG must be in YYYY/dir form +# YYYY must be a directory +# YYYY must be a writable directory +# YYYY/.year must be a non-empty file +# YYYY/dir must be a directory +# YYYY/dir/.path must be a non-empty file +# YEAR_ARG must match the contents of YYYY/dir/.path +# YYYY/dir/.entry.json must be a non-empty file +# +if [[ ! -d $YEAR_ARG ]]; then + echo "$0: ERROR: arg is not a directory: $YEAR_ARG" 1>&2 + exit 5 +fi +if [[ ! -w $YEAR_ARG ]]; then + echo "$0: ERROR: arg is not a writable directory: $YEAR_ARG" 1>&2 + exit 5 +fi +export YEAR_DIR=${YEAR_ARG%%/*} +if [[ -z $YEAR_DIR ]]; then + echo "$0: ERROR: arg not in YYYY/dir form: $YEAR_ARG" 1>&2 + exit 5 +fi + +# verify we have a non-empty readable .top file +# +export TOP_FILE=".top" +if [[ ! -e $TOP_FILE ]]; then + echo "$0: ERROR: .top does not exist: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -f $TOP_FILE ]]; then + echo "$0: ERROR: .top is not a regular file: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -r $TOP_FILE ]]; then + echo "$0: ERROR: .top is not an readable file: $TOP_FILE" 1>&2 + exit 6 +fi +if [[ ! -s $TOP_FILE ]]; then + echo "$0: ERROR: .top is not a non-empty readable file: $TOP_FILE" 1>&2 + exit 6 +fi + +# verify we have our awk script +# +export YEAR_NAVBAR_AWK="$BIN_DIR/subst.year-navbar.awk" +if [[ ! -e $YEAR_NAVBAR_AWK ]]; then + echo "$0: ERROR: bin/subst.year-navbar.awk does not exist: $YEAR_NAVBAR_AWK" 1>&2 + exit 6 +fi +if [[ ! -f $YEAR_NAVBAR_AWK ]]; then + echo "$0: ERROR: bin/subst.year-navbar.awk is not a file: $YEAR_NAVBAR_AWK" 1>&2 + exit 6 +fi +if [[ ! -r $YEAR_NAVBAR_AWK ]]; then + echo "$0: ERROR: bin/subst.year-navbar.awk is not a readable file: $YEAR_NAVBAR_AWK" 1>&2 + exit 6 +fi + +# determine The N-th IOCCC string +# +LINE_NUM=$(sed -n "/$YEAR_DIR/=" "$TOP_FILE" | head -1) +export LINE_NUM +if [[ -z $LINE_NUM ]]; then + echo '-e' + echo "cannot determine line number in $TOP_FILE for year: $YEAR_DIR" + echo '-E' + echo 220 + exit 220 +fi +ORDINAL=$(output_ordinal "$LINE_NUM") +export ORDINAL +if [[ -z $ORDINAL ]]; then + echo '-e' + echo "cannot determine ordinal for: $LINE_NUM" + echo '-E' + echo 221 + exit 221 +fi + +# parameter debugging +# +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: VERSION=$VERSION" 1>&2 + echo "$0: debug[3]: NAME=$NAME" 1>&2 + echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2 + echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2 + echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2 + echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 + echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2 + echo "$0: debug[3]: URL=$URL" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 + echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 + echo "$0: debug[3]: INC_PATH=$INC_PATH" 1>&2 + echo "$0: debug[3]: INC_DIR=$INC_DIR" 1>&2 + echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2 + echo "$0: debug[3]: BIN_DIR=$BIN_DIR" 1>&2 + echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 + echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 + echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2 + echo "$0: debug[3]: YEAR_NAVBAR_AWK=$YEAR_NAVBAR_AWK" 1>&2 + echo "$0: debug[3]: LINE_NUM=$LINE_NUM" 1>&2 + echo "$0: debug[3]: ORDINAL=$ORDINAL" 1>&2 +fi + +# If -N, time to exit +# +if [[ -n $DO_NOT_PROCESS ]]; then + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: arguments parsed, -N given, exit 0" 1>&2 + fi + exit 0 +fi + +# output TITLE substitution +# +echo "-s" +echo "TITIE=$YEAR_DIR - The $ORDINAL IOCCC" + +# output DESCRIPTION substitution +# +echo "-s" +echo "DESCRIPTION=IOCCC Year $YEAR_DIR" + +# output KEYWORDS substitution +# +echo "-s" +echo "KEYWORDS=IOCCC, $YEAR_DIR, IOCCC $YEAR_DIR, IOCCC entry, The $ORDINAL IOCCC" + +# output HEADER_2 substitution +# +echo "-s" +echo "HEADER_2=$YEAR_DIR - The $ORDINAL IOCCC" + +# output topnav links +# +awk -v year_arg="$YEAR_DIR" -f "$YEAR_NAVBAR_AWK" "$TOP_FILE" +status="$?" +if [[ $status -ne 0 ]]; then + echo "$0: ERROR: subst.year-navbar.awk failed, error: $status" 1>&2 + exit 219 +fi + +# All Done!!! -- Jessica Noll, Age 2 +# +exit 0 diff --git a/bin/subst.year-navbar.awk b/bin/subst.year-navbar.awk new file mode 100755 index 000000000..c67d19647 --- /dev/null +++ b/bin/subst.year-navbar.awk @@ -0,0 +1,137 @@ +#!/usr/bin/env awk +# +# subst.year-navbar.awk - output substitutions for navbar on behalf of a year +# +# This tool is usually invoked from the bin/subst.year-index.sh output tool. +# That tool, in turn, is usually invoked by: +# +# -o bin/subst.year-index.sh +# +# IMPORTANT: Each command line option / argument MUST be printed on a separate line! +# +# usage: +# +# awk -v year_arg=YYYY -f bin/subst.year-navbar.awk .top +# +# where: +# +# YYYY IOCCC year or mock + +BEGIN { + + # setup + # + VERSION="1.0 2024-02-11" + process_next_line = 0; # 1 ==> we found our year_arg, now process the next line + found_year_arg = 0; # 1 ==> we found our year_arg + prev_line = ""; # the previous YYYY line + topnav_phase = "year.mid"; # topnav name to use (-H topnav=topnav_phase) + + # error if year_arg is not set via -v year_arg=YYYY + # + if (length(year_arg) == 0) { + exit 210; # use 210 to match length(year_arg) == 0 error in the END section + } +} + +# process YYYY lines +# +{ + # obtain the YYYY line + # + year = $0; + + # if we need the line after we found our year_arg + # + if (process_next_line) { + + # process the line after we found our year_arg + # + # report the previous year + print "-s"; + print "RIGHT_LINK=../" year "/index.html"; + print "-s"; + print "RIGHT_TEXT=" year; + process_next_line = 0; + + # if we found our year_arg + # + } else if (year_arg == $0) { + + # in case our our year_arg is the 1st line + # + if (NR == 1) { + # no previous line year_arg is the 1st line + topnav_phase = "year.first"; + } + + # process the previous YYYY line with this match + # + if (prev_line) { + + # process previous line + # + prev_year = prev_line; + + # report the next entry for this year + print "-s"; + print "LEFT_LINK=../" prev_line "/index.html"; + print "-s"; + print "LEFT_TEXT=" prev_line; + } + + # process our found year_arg + # + # report up link top year index.html + print "-s"; + print "UP_LINK=../index.html"; + print "-s"; + print "UP_TEXT=top"; + process_next_line = 1; + found_year_arg = 1; + } + + # save the line as the next previous line + # + prev_line = $0; +} + +END { + + # error if github is not set via -v github=REPO_URL + # + if (length(year_arg) == 0) { + print "-e"; + print "ERROR: year_arg variable not set, call with -v year_arg=YYYY"; + print "-E"; + print "210"; # use 210 to match length(year_arg) == 0 error in the BEGIN section + exit 210; # use 210 to match length(year_arg) == 0 error in the BEGIN section + } + + # output inventory link information + # + print "-s"; + print "INVENTORY_LINK=#inventory"; + print "-s"; + print "INVENTORY_TEXT=Inventory"; + + # case: we did not find our year_arg + # + if (!found_year_arg) { + # ERROR: year_arg was not found + print "-e"; + print "'we did not find:", year_arg "'"; + print "-E"; + print "215"; + exit + + } else if (process_next_line) { + # no next line year_arg is the last line + topnav_phase = "year.last"; + } + + # output the topnav phase name + # + print "-H"; + print "topnav=" topnav_phase; +} diff --git a/inc/topnav.year.first.html b/inc/topnav.year.first.html new file mode 100644 index 000000000..ea625ef69 --- /dev/null +++ b/inc/topnav.year.first.html @@ -0,0 +1,10 @@ + + +
+ In 1st year + ↑ %%UP_TEXT%% ↑ + %%RIGHT_TEXT%% → + %%INVENTORY_TEXT%% +
+ + diff --git a/inc/topnav.year.last.html b/inc/topnav.year.last.html new file mode 100644 index 000000000..0f74c9188 --- /dev/null +++ b/inc/topnav.year.last.html @@ -0,0 +1,10 @@ + + +
+ ← %%LEFT_TEXT%% + ↑ %%UP_TEXT%% ↑ + In most recent year + %%INVENTORY_TEXT%% +
+ + diff --git a/inc/topnav.year.mid.html b/inc/topnav.year.mid.html new file mode 100644 index 000000000..0d34160aa --- /dev/null +++ b/inc/topnav.year.mid.html @@ -0,0 +1,10 @@ + + +
+ ← %%LEFT_TEXT%% + ↑ %%UP_TEXT%% ↑ + %%RIGHT_TEXT%% → + %%INVENTORY_TEXT%% +
+ +