fix Makefile and README.md for 2014/vik

2014/vik/.gitignore

@@ -1 +1,3 @@
+audio_file.raw
 prog
+prog.raw

2014/vik/Makefile

@@ -1,122 +1,193 @@
 #!/usr/bin/env make
 #
-# 2014 makefile
+# IOCCC 2014 winning entry - vik
+
+################################################################################
 #
-# 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
+CSILENCE= -Wno-bitwise-op-parentheses
-CWARN= -Wall -Wno-bitwise-op-parentheses
-#CWARN= -Wall -pedantic
 
-# 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=
 
-# 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
 #OPT= -O1
-OPT= -O2
+#OPT= -O2
-#OPT= -O3
+OPT= -O3
+
+# Default flags for ANSI C compilation
+#
+CFLAGS= ${CSTD} ${CWARN} ${ARCH} ${CDEFINE} ${CINCLUDE} ${OPT}
 
 # Libraries needed to build
 #
 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-implicit-int-conversion -Wno-missing-variable-declarations \
+	-Wno-poison-system-directories -Wno-shorten-64-to-32
+#
+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= vik
+PROG= prog
+#
+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 \
+	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
@@ -124,33 +195,52 @@ 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}
-
+	${RM} -f audio_file.raw prog.raw
-nuke: clobber
+	@-if [ -e sandwich ]; then \
-	@${TRUE}
+	    ${RM} -f sandwich; \
-
+	    echo 'ate sandwich'; \
-dist_clean: nuke
+	fi
-	@${TRUE}
 
 install:
-	@echo "Surely we are joking Dr. Science!"
+	@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
 
 
 ##################
@@ -169,35 +259,69 @@ waste:
 	@echo 'haste'
 	@${TRUE}
 
+maker:
+	@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 failong 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_v4; \
+	    ${RM} -f .code_anal_v6; \
 	else \
-	    echo "We are not expected to understand that"; \
+	    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 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 391581 --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: 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"

2014/vik/README.md

@@ -1,40 +1,44 @@
 # Best handling of beeps
 
-Daniel Vik  
+    Daniel Vik  
-<daniel@vik.cc>  
+    <daniel@vik.cc>  
-<http://danielvik.com/>  
+    <http://danielvik.com/>  
 
+# To build:
 
-## Judges' comments:
+```sh
-### To build:
+make
-
+```
-	make all
 
 ### To run:
 
-	./prog > foo.c
+```sh
+./prog > foo.c
+```
 
 ### Try:
 
-	echo 'Want to hear me beep?' | ./prog > audio_file.raw
+```sh
+echo 'Want to hear me beep?' | ./prog > audio_file.raw
 
-	echo 'No. I want chocolate!' | ./prog | mplayer -demuxer rawaudio -
+echo 'No. I want chocolate!' | ./prog | mplayer -demuxer rawaudio -
+```
 
-
+## Judges' comments:
-### Selected Judges Remarks:
 
 This program sets a new tone for obfuscation. But do you understand
 what it says about obfuscation? Perhaps:
 
-
+```sh
-	./prog < prog.c > prog.raw
+./prog < prog.c > prog.raw
-
+```
 
 might speak to your coding style? If not, then perhaps:
 
+```sh
+./prog < README.md | mplayer -demuxer rawaudio -
 
-	./prog < remarks.markdown | mplayer -demuxer rawaudio -
+```
-
 
 might help? :-)
 
@@ -43,6 +47,7 @@ machine entry](../../2020/ferguson2); see his
 [README.md](../../2020/ferguson2/README.md) for details (search for `vik`).
 
 ## Author's comments:
+
 ### Remarks
 
 This program converts ascii text to Morse audio file and vice versa. As far as
@@ -56,16 +61,15 @@ Don't forget the last '-' as it makes mplayer read from stdin.
 
 ## Convert audio file with Morse signals to text
 
-
+```sh
-	$ ./prog e < audio_file.raw
+./prog e < audio_file.raw
-
+```
 
 or alternatively pass a .wav file as input.
 
 The preferred input format 44.1kHz stereo, but it does a decent job on mono
 input and different frequencies as well.
 
-
 ### Portability
 
 The program is portable to most platforms. The only system dependency is that
@@ -75,8 +79,9 @@ Microsoft compilers add a carriage return to newlines, and to compile the
 program with this platform, the following line can be added after the main
 declaration in order for the program to run correctly:
 
-
+```c
-	_setmode(_fileno(stdout), 0x8000);
+_setmode(_fileno(stdout), 0x8000);
+```
 
 ### Known Issues
 
@@ -93,11 +98,10 @@ However I found some man made recordings on that decode reasonable well.
 If a recording doesn't decode, you could try to pre-process the input with a
 narrow bandpass filter on the frequency of the transmission.
 
---------------------------------------------------------------------------------
+## 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/
--->