fix .gitignore, Makefile and README.md for 2012/vik

2012/vik/.gitignore

@@ -1 +1,7 @@
+chocolate-in-ioccc.png
+encodedimg.png
+ioccc-in-chocolate.png
+restored-chocolate.png
+restored-ioccc.png
+restored.png
 vik

2012/vik/Makefile

@@ -1,96 +1,159 @@
 #!/usr/bin/env make
 #
-# 2012 makefile
+# IOCCC 2012 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 -W
+CSILENCE= -Wno-bitwise-op-parentheses -Wno-pointer-sign
-#CWARN= -Wall -W -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= -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
 #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= -lz
+#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 -Wno-sign-conversion
+#
+CWARN+= -Weverything
+#
+endif
+
+# Specific add-ons or replacements for gcc only
+#
+ifeq ($(CC),gcc)
+#
+#CSILENCE+=
+#
+#CWARN+=
+#
+endif
 
 
 ##############################
@@ -98,24 +161,33 @@ MAY_NEED_GCC= gcc
 ##############################
 #
 ENTRY= vik
+PROG= ${ENTRY}
+#
+OBJ= ${PROG}.o
 DATA= chocolate.png ioccc.png
+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
@@ -123,33 +195,53 @@ 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 encodedimg.png restored.png chocolate-in-ioccc.png ioccc-in-chocolate.png
-nuke: clobber
+	${RM} -f restored-chocolate.png restored-ioccc.png
-	@${TRUE}
+	@-if [ -e sandwich ]; then \
-
+	    ${RM} -f sandwich; \
-dist_clean: nuke
+	    echo 'ate sandwich'; \
-	@${TRUE}
+	fi
 
 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
 
 
 ##################
@@ -165,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/vik/README.md

@@ -1,55 +1,68 @@
 # Best use of cocoa - Bronze award
 
-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 vik
 
 This entry requires [Zlib](http://www.zlib.net/).
 
 ### To run:
 
-#### Embed text (from file or command line):
+To embed text (from file or command line):
 
-    ./vik e base.png filename > encodedimg.png
+```sh
-    # or
+./vik e base.png filename > encodedimg.png
-    ./vik e base.png SomeRandomText > encodedimg.png
+```
 
-#### Extract the embedded text:
+or
 
-    ./vik d encodedimg.png
+```sh
+./vik e base.png SomeRandomText > encodedimg.png
+```
 
-#### Embed a PNG into another
+To extract the embedded text:
 
-    ./vik e base.png source.png > encodedimg.png
+```sh
+./vik d encodedimg.png
+```
 
-#### Extract the embedded PNG:
+To embed a PNG into another:
 
-    ./vik d encodedimg.png > restored.png
+```sh
+./vik e base.png source.png > encodedimg.png
+```
+
+To extract the embedded PNG:
+
+```sh
+./vik d encodedimg.png > restored.png
+```
 
 ### Try:
 
-    ./vik e ioccc.png chocolate.png > chocolate-in-ioccc.png
+```sh
-    ./vik e chocolate.png ioccc.png > ioccc-in-chocolate.png
+./vik e ioccc.png chocolate.png > chocolate-in-ioccc.png
-    ./vik d chocolate-in-ioccc.png > restored-chocolate.png
+./vik e chocolate.png ioccc.png > ioccc-in-chocolate.png
-    ./vik d ioccc-in-chocolate.png > restored-ioccc.png
+./vik d chocolate-in-ioccc.png > restored-chocolate.png
+./vik d ioccc-in-chocolate.png > restored-ioccc.png
+```
 
-### Selected Judges Remarks:
+## Judges' comments:
 
 References to chocolate had no effect on judging this entry. We
 guarantee it.
 
-Can you discern hidden pieces of chocolate in chocolate-in-ioccc.png ?
+Can you discern hidden pieces of chocolate in `chocolate-in-ioccc.png`?
-
 
 ## Author's comments:
-Introduction
+
-------------
+### Introduction
 
 This program is a  steganography application for embedding an image or text
 into another image as well as extracting  the embedded image  or text back.
@@ -73,15 +86,18 @@ extracted image, and run it through  any of the previous  winning brain$#@$
 interpreters, but I thought it would be easier to include an interpreter in
 the program  to avoid the hassle:
 
-    ./vik e ioccc.png chocolate.png > encodedimg.png
+```sh
-    ./vik b encodedimg.png
+./vik e ioccc.png chocolate.png > encodedimg.png
+./vik b encodedimg.png
+```
 
 It is of course also possible  to embed a brain$#@$ program  as a text file
 (as explained above) and decode it, e.g.:
 
-    ./vik e ioccc.png .+[.+] > encodedimg.png
+```sh
-    ./vik b encodedimg.png
+./vik e ioccc.png .+[.+] > encodedimg.png
-
+./vik b encodedimg.png
+```
 
 ### Obfuscation
 
@@ -96,7 +112,6 @@ followed by a single return statement.  There is a little bit of use of the
 question mark operator,   but this is really  there to keep  the program as
 simple as possible.
 
-
 ### Portability
 
 The program is portable to most platforms that  have zlib  available.   The
@@ -108,8 +123,9 @@ compile the program on this platform, the following line can be added after
 the  variable  declarations  in  the  main  declaration  in  order  to  run
 correctly:
 
-    _setmode(_fileno(stdout), 0x8000);
+```c
-
+_setmode(_fileno(stdout), 0x8000);
+```
 
 ### Limitations
 
@@ -140,11 +156,10 @@ as well as the scan line filters.
 All these features  were quite easy to add,   much thanks to  the (actually
 pretty good) design of the code.
 
---------------------------------------------------------------------------------
+## 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/
--->