fix Makefile and README.md for 2015/dogon

2015/dogon/Makefile

@@ -1,36 +1,52 @@
 #!/usr/bin/env make
 #
-# 2015 makefile
+# IOCCC 2015 winning entry - dogon
+
+################################################################################
 #
-# This work by Landon Curt Noll, Simon Cooper, and Leonid A. Broukhis
+# Regarding individual entries:
-# is licensed under:
+#
+# IOCCC winning entry code may not work on your system.  Even with standards,
+# conditions and build environments change, especially when it comes to more
+# extreme code such you might find in an IOCCC winner.  Moreover, what was
+# allowed and liked in one IOCCC contest may no longer be liked/allowed in
+# later IOCCC years.
+#
+# Corrections on winning author and fixing typos in remarks are VERY WELCOME.
+#
+# GitHub pull requests are welcome:
+#
+# If you have a patch that might make running an entry work in modern Unix-like
+# environments, please create a GitHub pull request for the IOCCC judges to
+# consider.
+#
+# Suggestions and corrections regarding Makefiles, winning author information,
+# fixing typos in remarks, and code patches are welcome via opening a GitHub
+# issue or better yet, by creating a GitHub pull request for the IOCCC judges
+# to consider.  To form a GitHub issue or GitHub pull, please visit:
+#
+# https://github.com/ioccc-src/winner
+#
+################################################################################
+
+# This work by Landon Curt Noll and Leonid A. Broukhis is licensed under:
 #
 #	Creative Commons Attribution-ShareAlike 3.0 Unported License.
 #
 # See: http://creativecommons.org/licenses/by-sa/3.0/
 
 
-################
+#############################
-# tool locations
+# shell used by this Makefile
-################
+#############################
 #
 SHELL= bash
-CP= cp
+
-CPP= cpp
+#######################
-GUNZIP= gunzip
+# common tool locations
-BUNZIP2= bunzip2
+#######################
-LD= ld
+#
-MAKE= make
+include ../../var.mk
-RM= rm
-SED= sed
-TAR= tar
-TRUE= true
-MKDIR= mkdir
-MV= mv
-TR= tr
-GREP= grep
-SORT= sort
-UNIQ= uniq
 
 # Set X11_LIBDIR to the directory where the X11 library resides
 #
@@ -44,56 +60,53 @@ X11_LIBDIR= /opt/X11/lib
 #X11_INCDIR= /usr/X11/include
 X11_INCDIR= /opt/X11/include
 
-# Compiler warnings
+# Common C compiler warnings to silence
-#
-#CWARN=
-#CWARN= -Wall
-#CWARN= -Wall -Wextra
-CWARN= -Wall -Wextra -pedantic ${CSILENCE}
-#CWARN= -Wall -Wextra -Weverything
-#CWARN= -Wall -Wextra -Weverything -pedantic
-#CWARN= -Wall -Wextra -Weverything -pedantic ${CSILENCE}
-
-# Silence warnings that ${CWARN} would normally complain about
 #
 #CSILENCE=
-CSILENCE= -Wno-implicit-int -Wno-variadic-macros -Wno-absolute-value \
+CSILENCE= -Wno-absolute-value -Wno-char-subscripts -Wno-dangling-else -Wno-error \
-	  -Wno-bitwise-op-parentheses -Wno-char-subscripts -Wno-dangling-else \
+	-Wno-implicit-function-declaration -Wno-parentheses \
-	  -Wno-implicit-function-declaration -Wno-parentheses \
+	-Wno-shift-op-parentheses -Wno-implicit-int
-	  -Wno-shift-op-parentheses -Wno-unsequenced -Wno-conversion \
-	  -Wno-float-conversion -Wno-missing-variable-declarations \
-	  -Wno-reserved-id-macro -Wno-shadow -Wno-shorten-64-to-32 \
-	  -Wno-sign-conversion
 
-# compiler standard
+# Common C compiler warning flags
+#
+#CWARN= ${CSILENCE}
+#CWARN= -Wall ${CSILENCE}
+#CWARN= -Wall -Wextra ${CSILENCE}
+CWARN= -Wall -Wextra -pedantic ${CSILENCE}
+
+# Compiler standard
 #
 #CSTD=
 #CSTD= -ansi
-CSTD= -std=c11
+CSTD= -std=gnu11
 
-# compiler bit architecture
+# Compiler bit architecture
 #
 # Some entries require 32-bitness:
 # ARCH= -m32
 #
-# Some entries require 64-bitess:
+# Some entries require 64-bitness:
 # ARCH= -m64
 #
 # By default we assume nothing:
 #
 ARCH=
 
-# defines that are needed to compile
+# Defines that are needed to compile
 #
 #CDEFINE=
 CDEFINE= -DW=1024 -Dp=800
 
-# include files that are needed to compile
+# Include files that are needed to compile
 #
 #CINCLUDE=
-CINCLUDE= -I ${X11_INCDIR} -include stdlib.h
+#CINCLUDE= -include stdlib.h
+#CINCLUDE= -include stdio.h
+#CINCLUDE= -include stdlib.h -include stdio.h
+CINCLUDE= -include stdio.h -I ${X11_INCDIR} -I ${X11_INCDIR}/X11
+#CINCLUDE= `${SDL2_CONFIG} --cflags`
 
-# optimization
+# Optimization
 #
 # Most compiles will safely use -O2.  Some can use only -O1 or -O.
 # A few compilers have broken optimizers or this entry make break
@@ -106,57 +119,79 @@ CINCLUDE= -I ${X11_INCDIR} -include stdlib.h
 #OPT= -O2
 OPT= -O3
 
-# default flags for ANSI C compilation
+# Default flags for ANSI C compilation
 #
-CFLAGS= ${CWARN} ${CSTD} ${ARCH} ${CDEFINE} ${CINCLUDE} ${OPT}
+CFLAGS= ${CSTD} ${CWARN} ${ARCH} ${CDEFINE} ${CINCLUDE} ${OPT}
 
 # Libraries needed to build
 #
 #LIBS=
-LIBS= -L ${X11_LIBDIR} -lm -lX11
+#LIBS= -lm
+LIBS= -lm -L ${X11_LIBDIR} -lX11
+#LIBS= `${SDL2_CONFIG} --libs`
 
-# ANSI compiler
+# C compiler to use
-#
-# Set CC to the name of your ANSI compiler.
-#
-# Some entries seem to need gcc.  If you have gcc, set
-# both CC and MAY_NEED_GCC to gcc.
-#
-# If you do not have gcc, set CC to the name of your ANSI compiler, and
-# set MAY_NEED_GCC to either ${CC} (and hope for the best) or to just :
-# to disable such programs.
 #
 CC= cc
 #CC=clang
-MAY_NEED_GCC= gcc
+#CC=gcc
+
+# Compiler add-ons or replacements for clang only
+#
+ifeq ($(CC),clang)
+#
+
+CSILENCE+= -Wno-double-promotion -Wno-float-conversion -Wno-implicit-float-conversion \
+	-Wno-missing-variable-declarations -Wno-poison-system-directories \
+	-Wno-shadow -Wno-shorten-64-to-32 -Wno-sign-conversion
+#
+CWARN+= -Weverything
+#
+endif
+
+# Specific add-ons or replacements for gcc only
+#
+ifeq ($(CC),gcc)
+#
+#CSILENCE+=
+#
+#CWARN+=
+#
+endif
 
 
 ##############################
 # Special flags for this entry
 ##############################
 #
-ENTRY= prog
+ENTRY= dogon
-CSRC= ${ENTRY}.c
+PROG= prog
-OBJ= ${ENTRY}.o
+#
+OBJ= ${PROG}.o
 DATA=
+TARGET= ${PROG}
+#
 ALT_OBJ=
-ALT_ENTRY=
+ALT_TARGET=
-TARGET= ${ENTRY}
 
 
 #################
 # build the entry
 #################
 #
-all: ${TARGET} ${DATA}
+all: data ${TARGET}
 	@${TRUE}
 
-${ENTRY}: ${CSRC}
+.PHONY: all alt data everything clean clobber install \
+	love haste waste maker easter_egg sandwich \
+	supernova deep_magic magic charon pluto
+
+${PROG}: ${PROG}.c
 	${CC} ${CFLAGS} $< -o $@ ${LIBS}
 
 # alternative executable
 #
-alt: ${ALT_ENTRY}
+alt: data ${ALT_TARGET}
 	@${TRUE}
 
 # data files
@@ -164,33 +199,51 @@ alt: ${ALT_ENTRY}
 data: ${DATA}
 	@${TRUE}
 
+# both all and alt
+#
+everything: all alt
+
 
 ###############
 # utility rules
 ###############
 #
-everything: all alt
-
 clean:
 	${RM} -f ${OBJ} ${ALT_OBJ}
+	@-if [ -f indent.c ]; then \
+	    echo ${RM} -f indent.c; \
+	    ${RM} -f indent.c; \
+	fi
 
 clobber: clean
-	${RM} -f ${TARGET} ${ALT_ENTRY}
+	${RM} -f ${TARGET} ${ALT_TARGET}
-
+	@-if [ -e sandwich ]; then \
-nuke: clobber
+	    ${RM} -f sandwich; \
-	@${TRUE}
+	    echo 'ate sandwich'; \
-
+	fi
-dist_clean: nuke
-	@${TRUE}
 
 install:
-	@echo "Surely we are joking Dr. May!"
+	@echo "Dr. Spock says that is not logical!"
 	@${TRUE}
 
-# backwards compatibility
+# you may be able to misunderstand the source by reading indent.c
 #
-build: all
+indent.c: ${PROG}.c
-	@${TRUE}
+	@if which "${GINDENT}" >/dev/null 2>&1; then \
+	    echo ${RM} -f $@; \
+	    ${RM} -f $@; \
+	    echo "${GINDENT} < $< > $@"; \
+	    ${GINDENT} < $< > $@; \
+	elif which "${INDENT}" >/dev/null 2>&1; then \
+	    echo ${RM} -f $@; \
+	    ${RM} -f $@; \
+	    echo "${INDENT} < $< > $@"; \
+	    ${INDENT} < $< > $@; \
+	else \
+	    echo "no intent tool found, ident $< yourself, sorry"; \
+	    echo "exit 1"; \
+	    exit 1; \
+	fi
 
 
 ##################
@@ -209,54 +262,69 @@ waste:
 	@echo 'haste'
 	@${TRUE}
 
-make:
+maker:
-	@echo 'Attend a maker faire'
+	@echo 'Participate in a maker faire'
 	@${TRUE}
 
 easter_egg:
-	@echo you expected to sometimes mis-understand this $${RANDOM} magic
+	@echo "you expected to often misunderstand this $${RANDOM} magic"
-	@echo chongo '<was here>' "/\\oo/\\"
+	@echo "chongo '<was here>' /\\oo/\\"
-	@echo Readers shall not be disallowed from not failing to be unable to not partly misunderstand this partocular final echo.
+	@echo "Eggy"
+
+sandwich: easter_egg
+	@if [ `id -u` -eq 0 ]; then \
+	    echo 'Okay.'; \
+	    echo "$${RANDOM}`date +%s`$${RANDOM}" > $@; \
+	else \
+	    echo 'What? Make it yourself.'; \
+	    exit 1; \
+	fi
 
 # Understand the history of the Homebrew Computer Club
 # as well as the West Coast Computer Faire and
 # you might be confused different.  :-)
 #
-supernova: nuke
+supernova: sandwich
 	@-if [ -r .code_anal ]; then \
-	    ${RM} -f .code_anal_v5; \
+	    ${RM} -f .code_anal_v6; \
 	else \
-	    echo "planet deniers, like the IAU, are amusing"; \
+	    echo "planet deniers, like some members of the IAU, are so cute when they try to defend their logic"; \
 	fi
-	@echo A $@ helps ${MAKE} the elements that help form planets
+	@echo "A $@ helps ${MAKE} the elements that help form planets"
 	@${TRUE}
 
-deep_magic:
+deep_magic: supernova
 	@-if [ -r .code_anal ]; then \
-	    ccode_analysis --deep_magic 2ed3582ec5c094a093fea2a6bcb9f19439892873c9cc45ed1ceaafe08b7d52e1b2c7cd524be3b0b2 --FNV1a_hash_512_bit "${ENTRY}"; \
+	    ccode_analysis --deep_magic 7889066cdbdf09b0408021754586e895be641cc9be29e7eafd3ca65359541f17 \
+	    		   --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
 	else \
-	    echo "You are holding it wrong!"; \
+	    echo "Wrong! Do it again!"; \
+	    sleep 2; \
+	    echo "Wrong! Do it again!"; \
+	    sleep 2; \
+	    echo "Wrong! Do it again!"; \
 	fi
 	@${TRUE}
 
 magic: deep_magic
 	@-if [ -r .code_anal ]; then \
-	    ccode_analysis --mode 216091 --level 216193 --FNV1a_hash_512_bit "${ENTRY}"; \
+	    ccode_analysis --level 20003 --mode 5717175 --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
 	else \
-	    echo "These aren't the primes you're looking for Pauline!"; \
+	    echo "If you don't eat yer meat, you can't have any pudding!"; \
+	    echo "How can you have any pudding if you don't eat yer meat?!"; \
 	fi
 	@${TRUE}
 
 # The IOCCC resident astronomer states
 #
-charon: supernova
+charon: magic
-	@echo $@ is a dwarf planet
+	@echo "$@ is a dwarf planet"
-	@echo dwarf is a type of planet
+	@echo "dwarf is a type of planet"
-	@echo $@ is a planet
+	@echo "therefore IAU, $@ is a planet"
 
-pluto: supernova
+pluto: charon
 	${MAKE} charon
-	@echo $@ is a dwarf planet
+	@echo "$@ is a dwarf planet"
-	@echo dwarf is a type of planet
+	@echo "dwarf is a type of planet"
-	@echo $@ is a planet
+	@echo "therefore, $@ is a planet"
-	@echo get used to having lots of planets becasue supernovae can ${MAKE} a lot of them
+	@echo "having lots of planets is good feature because supernovae can help ${MAKE} a lot of them"

2015/dogon/README.md

@@ -1,47 +1,53 @@
 # Most Crafty
 
-Gil Dogon  
+    Gil Dogon  
-<http://sokoban-gild.com>  
+    <http://sokoban-gild.com>  
 
+# To build:
 
-## Judges' comments:
+```sh
-### To use:
+make
+```
 
-    make
+### To run:
 
-    ./prog
+```sh
+./prog
+```
 
 ### Try:
 
-    ./prog
+```sh
+./prog
+```
 
-    press and hold the Left Arrow key until you turn 90-degrees to the left
+Press and hold the Left Arrow key until you turn 90-degrees to the left
 
-    when you see a long tunnel, press the function key F2
+When you see a long tunnel, press the function key F2
 
-    Use the Up, Down, Left and Right keys to change your path
+Use the Up, Down, Left and Right keys to change your path
 
-    Press function higher numbered function keys (F3, F4, ...) to go faster
+Press function higher numbered function keys (F3, F4, ...) to go faster
 
-    Press F1 to stop
+Press F1 to stop
 
-    Turn 90-degrees to one side
+Turn 90-degrees to one side
 
-    Press F4 to and drill into some blocks for a bit
+Press F4 to and drill into some blocks for a bit
 
-    Press F1 to stop
+Press F1 to stop
 
-    Turn 180-degrees to face the way you came
+Turn 180-degrees to face the way you came
 
-    Press F2 and navigate back down the new hole until you reach the long tunnel again
+Press F2 and navigate back down the new hole until you reach the long tunnel again
 
-    Press F1 to stop
+Press F1 to stop
 
-    etc.
+etc.
 
-    Press the ESC key
+Press the ESC key
 
-### Selected Judges Remarks:
+## Judges' comments:
 
 You are in a twisty maze blocks, almost all alike.
 
@@ -54,6 +60,7 @@ How many function keys does your keyboard have?  Can you generate very high numb
 *Textures? We don't need no stinking textures.*
 
 ## Author's comments:
+
 ### What is it?
 
 Just run prog with no arguments on an X11-compatible system. The scenery, though pseudo-randomly generated should be strangely familiar, specially to those still in their teen age. You can navigate using the keyboard arrow keys and the function keys. Your speed is a linear function of (n-1) where Fn is the last function key you have pressed, and you always move in the direction you are looking at. Be aware that you are probably some kind of a Creeper as is obvious from looking at the program, hence your movement is destructive to the environment. So after pressing F12 for warp speed, and moving around randomly, you might find yourself in a 3D maze of twisty little passages, from which there is only one Esc(ape) key. Note that in theory if you have a specialty keyboard with 32 function keys you may even press F31 to reach infinite improbability drive speed, though the author had never tested this feature. However a hidden comment in keysymdef.h suggests the existence of a mythical Sun Keyboard with 35 function keys :)
@@ -78,8 +85,9 @@ This entry is rather portable I think on modern platforms. It assumes of course
 * The entry assumes the default visual has 24 bit depth (RGB). This seems to be the case on most X Servers this days.
 * The entry, does a thing which is an absolute No-No for X-windows program, i.e. assuming it knows some numeric values for keysyms defined in keysymdef.h . I have searched far and wide the lord Google's domain, yet was unable to find a version of the file where those assumptions were broken. This enables the important support of up to 32 function keys keyboards without spilling over the size limit, and allows us to use such fun expression for arrow view control as the following:
 
-       *(a&1?&C:&B)-=(.05 -a/2%2*.1)*!(a-1&4092^3920)
+```c
-
+*(a&1?&C:&B)-=(.05 -a/2%2*.1)*!(a-1&4092^3920)
+```
 
 ### Precision issues.
 
@@ -101,11 +109,10 @@ Evidently when doing such arithmetics, care must me taken to avoid overflow from
 
 Similar technique is used on the RGB components so their brightness can be adjusted simultaneously by the expression: o=o*b>>8 . Of course some spare bits are needed between the components, so they are spread in the long long and reordered as RBG.
 
---------------------------------------------------------------------------------
+## Copyright:
-<!--
+
 (c) Copyright 1984-2016, [Leo Broukhis, Simon Cooper, Landon Curt Noll][judges] - All rights reserved
 This work is licensed under a [Creative Commons Attribution-ShareAlike 3.0 Unported License][cc].
 
 [judges]: http://www.ioccc.org/judges.html
 [cc]: http://creativecommons.org/licenses/by-sa/3.0/
--->