fix Makefile and README.md for 2012/blakely

2012/blakely/Makefile

@@ -1,67 +1,115 @@
 #!/usr/bin/env make
 #
-# 2012 makefile
+# IOCCC 2012 winning entry - blakely
+
+################################################################################
 #
-# 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
-LD= ld
+#######################
-MAKE= make
+#
-RM= rm
+include ../../var.mk
-SED= sed
-TAR= tar
-TRUE= true
 
 # Set X11_LIBDIR to the directory where the X11 library resides
 #
-X11_LIBDIR= /usr/X11R6/lib
+#X11_LIBDIR= /usr/X11R6/lib
+#X11_LIBDIR= /usr/X11/lib
+X11_LIBDIR= /opt/X11/lib
 
 # Set X11_INCLUDEDIR to the directory where the X11 include files reside
 #
-X11_INCDIR= /usr/X11R6/include
+#X11_INCDIR= /usr/X11R6/include
+#X11_INCDIR= /usr/X11/include
+X11_INCDIR= /opt/X11/include
 
-# Compiler warnings
+# Common C compiler warnings to silence
 #
-#CWARN=
+#CSILENCE=
-#CWARN= -Wall -W
+CSILENCE= -Wno-error -Wno-implicit-function-declaration -Wno-unused-parameter
-CWARN= -Wall -W -pedantic -Wno-unused-parameter
 
-# 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= -ansi
-#CSTD= -std=c99
+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=
 
-# optimization
+# Defines that are needed to compile
+#
+CDEFINE=
+#CDEFINE= -DIOCCC
+
+# Include files that are needed to compile
+#
+CINCLUDE=
+#CINCLUDE= -include stdlib.h
+#CINCLUDE= -include stdio.h
+#CINCLUDE= -include stdlib.h -include stdio.h
+#CINCLUDE= -I ${X11_INCDIR} -I ${X11_INCDIR}/X11
+#CINCLUDE= `${SDL2_CONFIG} --cflags`
+
+# 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
 # under those buggy optimizers and thus you may not want anything.
+# Reasonable compilers will allow for -O3.
 #
 #OPT=
 #OPT= -O
@@ -69,28 +117,45 @@ ARCH=
 #OPT= -O2
 OPT= -O3
 
+# Default flags for ANSI C compilation
+#
+CFLAGS= ${CSTD} ${CWARN} ${ARCH} ${CDEFINE} ${CINCLUDE} ${OPT}
+
 # Libraries needed to build
 #
-LIBS= -lm
+LIBS=
+#LIBS= -lm
+#LIBS= -L ${X11_LIBDIR} -lX11
+#LIBS= `${SDL2_CONFIG} --libs`
 
-# default flags for ANSI C compilation
+# C compiler to use
-#
-CFLAGS= ${CWARN} ${CSTD} ${ARCH} ${OPT}
-
-# ANSI compiler
-#
-# 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-comma -Wno-float-conversion -Wno-float-equal \
+	-Wno-implicit-int-conversion -Wno-missing-prototypes \
+	-Wno-missing-variable-declarations -Wno-poison-system-directories \
+	-Wno-shadow -Wno-sign-conversion -Wno-strict-prototypes -Wno-unused-macros
+#
+CWARN+= -Weverything
+#
+endif
+
+# Specific add-ons or replacements for gcc only
+#
+ifeq ($(CC),gcc)
+#
+#CSILENCE+=
+#
+#CWARN+=
+#
+endif
 
 
 ##############################
@@ -98,25 +163,33 @@ MAY_NEED_GCC= gcc
 ##############################
 #
 ENTRY= blakely
+PROG= ${ENTRY}
+#
+OBJ= ${PROG}.o
 DATA=
+TARGET= ${PROG}
+#
 ALT_OBJ=
-ALT_ENTRY=
+ALT_TARGET=
 
 
 #################
 # build the entry
 #################
 #
-all: ${ENTRY} ${DATA}
+all: data ${TARGET}
 	@${TRUE}
 
-${ENTRY}: ${ENTRY}.c
+.PHONY: all alt data everything clean clobber install \
-	${CC} ${CFLAGS} -include stdio.h -include math.h -include stdlib.h \
+	love haste waste maker easter_egg sandwich \
-	    $< -o $@ ${LIBS}
+	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
@@ -124,33 +197,51 @@ alt: ${ALT_ENTRY}
 data: ${DATA}
 	@${TRUE}
 
+# both all and alt
+#
+everything: all alt
+
 
 ###############
 # utility rules
 ###############
 #
-everything: all alt
-
 clean:
-	${RM} -f ${ENTRY}.o ${ALT_OBJ}
+	${RM} -f ${OBJ} ${ALT_OBJ}
+	@-if [ -f indent.c ]; then \
+	    echo ${RM} -f indent.c; \
+	    ${RM} -f indent.c; \
+	fi
 
 clobber: clean
-	${RM} -f ${ENTRY} ${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 you're joking Mr. Feynman!"
+	@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
 
 
 ##################
@@ -166,39 +257,72 @@ haste:
 	@${TRUE}
 
 waste:
-	@echo 'waste'
+	@echo 'haste'
+	@${TRUE}
+
+maker:
+	@echo 'Participate in a maker faire'
 	@${TRUE}
 
 easter_egg:
-	@echo you expected to 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 be disallowed from not being unable to partly misunderstand this partocular final echo.
+	@echo "Eggy"
 
-# Understand the history of "I Am the Walrus" and
+sandwich: easter_egg
-# and in particular John Lennon's remarks on that
+	@if [ `id -u` -eq 0 ]; then \
-# song and you might be confused about these next
+	    echo 'Okay.'; \
-# rules in a different way. :-)
+	    echo "$${RANDOM}`date +%s`$${RANDOM}" > $@; \
-#
-supernova: nuke
-	@-if [ -r .code_anal ]; then \
-	    ${RM} -f .code_anal_v3; \
 	else \
-	    echo "You are not expected to understand this"; \
+	    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: sandwich
+	@-if [ -r .code_anal ]; then \
+	    ${RM} -f .code_anal_v6; \
+	else \
+	    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"
 	@${TRUE}
 
-deep_magic:
+deep_magic: supernova
 	@-if [ -r .code_anal ]; then \
-	    ccode_analysis --deep_magic 1c2c85c7a02c55d1add91967eca491d53c101dc1 --FNV1a_hash 256-bit "${ENTRY}"; \
+	    ccode_analysis --deep_magic 7889066cdbdf09b0408021754586e895be641cc9be29e7eafd3ca65359541f17 \
+	    		   --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
 	else \
-	    echo "Understand different"; \
+	    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 21701 --level 23209 --FNV1a_hash 256-bit "${ENTRY}"; \
+	    ccode_analysis --level 20003 --mode 5717175 --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
 	else \
-	    echo "These aren't the droids you're looking for Mr. Spock!"; \
+	    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: magic
+	@echo "$@ is a dwarf planet"
+	@echo "dwarf is a type of planet"
+	@echo "therefore IAU, $@ is a planet"
+
+pluto: charon
+	${MAKE} charon
+	@echo "$@ is a dwarf planet"
+	@echo "dwarf is a type of planet"
+	@echo "therefore, $@ is a planet"
+	@echo "having lots of planets is good feature because supernovae can help ${MAKE} a lot of them"

2012/blakely/README.md

@@ -1,28 +1,32 @@
 # Most GIFted expressions
 
-Philip Blakely  
+    Philip Blakely  
-Cambridge, UK  
+    Cambridge, UK  
-<pmblakely@gmail.com>  
+    <pmblakely@gmail.com>  
 
+# To build:
 
-## Judges' comments:
+```sh
-### To build:
+make
-
+```
-    make blakely
 
 ### To run:
 
-    ./blakely "RPN formula" resolution > output.gif
+```sh
+./blakely "RPN formula" resolution > output.gif
+```
 
 ### Try:
 
-    ./blakely "xx*yy*+" 64 > paraboloid.gif
+```sh
+./blakely "xx*yy*+" 64 > paraboloid.gif
 
-    ./blakely 9 32 > empty.gif
+./blakely 9 32 > empty.gif
 
-    time ./blakely 0 250 > flat.gif
+time ./blakely 0 250 > flat.gif
+```
 
-### Selected Judges Remarks:
+## Judges' comments:
 
 Several IOCCC themes (RPN calculator, animated GIF generator, ray tracing) in one package! Very impressive!
 
@@ -30,21 +34,22 @@ The checkerboard pattern in the output can be broken. Could you figure out how?
 
 Larger GIF files confuse some image viewers.
 
-
 ## Author's comments:
-Remarks
+
--------
+### Remarks
 
 This program renders a generic RPN expression in ray-traced animated GIF form.
 The expression in spatial variables x and y is specified on the command-line with the required resolution,
 and an animated GIF showing a fly-around of the resulting surface is output to stdout.
 
-Usage
+### Usage
------
 
 The program should be run as:
 
-    ./blakely xy* 32 > pic.gif
+```sh
+./blakely xy* 32 > pic.gif
+```
+
 where the first parameter is a RPN expression, and the second is the width of the required GIF, up to a maximum of 250.
 
 The expressions are written in Reverse Polish Notation with the following characters recognised:
@@ -65,42 +70,40 @@ The surface plotted corresponds to -1 <= x,y <= 1 and for best results, the gene
 
 If there is a division by zero, square-root of a negative number, or similar operation, then the results are undefined.
 
-Examples
+### Examples
---------
 
 For test-runs, use a resolution of 32. For simple expressions, the GIF generation should take only
 a few seconds with a modern processor and full optimization. Run-time scales as O(N^3) with resolution N,
 and more complex expressions take longer to compute. For example, increasing the resolution of ripple.gif
 to 250 took ~35 minutes to render on an i7 processor.
 
-    ./blakely xy* 32 > saddle.gif
+```sh
+./blakely xy* 32 > saddle.gif
 
-    ./blakely xx*yy*1++d5*ct/ 64 > ripple.gif
+./blakely xx*yy*1++d5*ct/ 64 > ripple.gif
+```
 
-Algorithm
+### Algorithm
----------
 
 A generic root-finding algorithm to find the point of intersection between a ray
 and the surface is done using a simple forward search from the eye.
 In order to make the rendering realistic, both the value of the expression, and its derivative with respect to x and y must be tracked.
 This is done using an obvious stack-based approach.
 
-Obfuscations
+### Obfuscations
-------------
 
 Much of the obfuscation is achieved through the use of single-letter variables and #defines.
 The characters output for the GIF format are generated in myriad and wonderful ways, making use
 of XOR, return values from putchar, and odd expressions.
 The layout is in the form of X Y Z.
 
-Limitations
+### Limitations
------------
+
 ASCII is assumed since many bytes for the GIF output are generated from characters given in the source code.
 On compilation a few warnings about parentheses come up when using gcc 4.6.3, and one about no return value from main() (who uses exit codes anyway?),
 but clang 3.1 emits no warnings.
 
-Questions
+### Questions
----------
 
 * Apart from their appearance when computing the RPN expression, sin and cos are not used.
   How do we then get the correct angles for rotation?
@@ -111,11 +114,10 @@ Questions
 
 (Note that the author may or may not be able to answer all of the above questions.)
 
---------------------------------------------------------------------------------
+## Copyright:
-<!--
+
 (c) Copyright 1984-2015, [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/
--->