fix Makefile and README.md for 2000/primenum

2000/primenum/Makefile

@@ -1,215 +1,327 @@
-#!/bin/make
+#!/usr/bin/env make
-# 2000 makefile
 #
-# Copyright (C) Simon Cooper, Landon Curt Noll, Peter Seebach
+# IOCCC 2000 winning entry - primenum
-# and Leonid A. Broukhis, 2000.
-# All Rights Reserved.  Permission for personal, educational or non-profit
-# use is granted provided this this copyright and notice are included in its
-# entirety and remains unaltered.  All other uses must receive prior permission
-# from the contest judges.
 
-SHELL= /bin/sh
+################################################################################
-CAT= cat
-RM= rm
-SED= sed
-TRUE= true
-#CINCLUDE= -I ${HOMEBREW_PREFIX}/include/SDL2
-
-# optimization
 #
-# Most compiles will safely use -O2.  Some can use only -O.
+# Regarding individual entries:
-# A few compilers have broken optimizers and thus you may
+#
-# not want anything.
+# 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/
+
+
+#############################
+# shell used by this Makefile
+#############################
+#
+SHELL= bash
+
+#######################
+# common tool locations
+#######################
+#
+include ../../var.mk
+
+# Set X11_LIBDIR to the directory where the X11 library resides
+#
+#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/X11/include
+X11_INCDIR= /opt/X11/include
+
+# Common C compiler warnings to silence
+#
+#CSILENCE=
+CSILENCE= -Wno-error -Wno-implicit-function-declaration -Wno-main-return-type \
+	-Wno-unused-parameter
+
+# 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=gnu99
+
+# Compiler bit architecture
+#
+# Some entries require 32-bitness:
+# ARCH= -m32
+#
+# Some entries require 64-bitness:
+# ARCH= -m64
+#
+# By default we assume nothing:
+#
+ARCH=
+
+# 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= -O2
+#OPT= -O1
+#OPT= -O2
+OPT= -O3
 
-# flags for ANSI compiles
+# Default flags for ANSI C compilation
 #
-# NOTE: Some ANSI compilers make use of -Xa to turn on ANSI mode,
+CFLAGS= ${CSTD} ${CWARN} ${ARCH} ${CDEFINE} ${CINCLUDE} ${OPT}
-#	others such as gcc may want -ansi, others (Compaq Tru64 Unix)
-#       want -std1, and others may want nothing at all.
-#       Adjust the CFLAGS line as needed.
-#
-# NOTE: Some compilers cannot optimize, or optimize some entries
-#	incorrectly.  You might want to turn on -O to see if your
-#	compiler can handle them.
-#
-#
-#CFLAGS= -Xa ${OPT}
-#CFLAGS= -std1 $(OPT)
-CFLAGS= -ansi ${OPT}
 
-NO_ANSI_CFLAGS=
+# Libraries needed to build
-#NO_ANSI_CFLAGS=
+#
+LIBS=
+#LIBS= -lm
+#LIBS= -L ${X11_LIBDIR} -lX11
+#LIBS= `${SDL2_CONFIG} --libs`
 
-# NOTE: On some systems, the library path does not include the location
+# C compiler to use
-#	of the X11 libraries.  You might need to use a -L/path/to/X11/lib/dir
-#	in order to compile with these libs.
-#
-X11CCFLAGS= -I/usr/X11R6/include -I/usr/X11R6/include/X11 -I/usr/include/X11
-#X11CCFLAGS=
-X11LDFLAGS= -L/usr/X11R6/lib
-#X11LDFLAGS=
-
-# Perl
-#
-PERL= perl
-#PERL= perl5
-
-# 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
-MAY_NEED_GCC= gcc
+#CC=clang
+#CC=gcc
 
-# winners that compile under ANSI C
+# Compiler add-ons or replacements for clang only
 #
-WINNERS= anderson schneiderwent primenum bellard bmeyer briddlebane dhyang \
+ifeq ($(CC),clang)
-	dmy2jd jarijyrki dlowe natori rince robison thadgavin tomx
-ALT_NAMES= schneiderwent.orig briddlebane.orig thadgavin.orig
-DATA_FILES= schneiderwent_files bmeyer_files jarijyrki_files
-
-
-all: ${WINNERS}
-
-# Best use of flags
 #
-anderson: anderson.c
+CSILENCE+= -Wno-implicit-int-conversion -Wno-poison-system-directories
-	${CC} ${CFLAGS} $? -o $@
-
-# Most Timely Output
 #
-schneiderwent: schneiderwent.c
+CWARN+= -Weverything
-	${CC} ${CFLAGS} $? -o $@
-
-schneiderwent_files: schneiderwent.data
-
-schneiderwent.orig: schneiderwent.orig.c
-	${CC} ${CFLAGS} $? -o $@
-
-# Best Abuse of CPP
 #
-primenum: primenum.c
+endif
-	${CC} ${CFLAGS} $? -o $@
 
-# Most Specific Output
+# Specific add-ons or replacements for gcc only
 #
-bellard: bellard.c
+ifeq ($(CC),gcc)
-	${CC} ${CFLAGS} $? -o $@
+#
+#CSILENCE+=
+#
+#CWARN+=
+#
+endif
 
-# Best Utility
-#
-# machines operating in 64 bit mode:
-#
-bmeyer: bmeyer.c
-	${CC} -DY= -O6 $? -o $@ -lm
-#
-# linux/x86, glibc 2.0, libc4/5:
-#
-# bmeyer: bmeyer.c
-# 	${CC} -DY="__setfpucw(0x127f)" -O6 $? -o $@ -lm
-#
-# linux/x86, glibc 2.1:
-#
-# bmeyer: bmeyer.c
-# 	${MAY_NEED_GCC} -DY='int x=0x127f; __asm__ ("fldcw %0" : : "m" (*&x))' \
-# 			-O6 $? -o $@ -lm
 
-bmeyer_files: lavabus.pgm lenna.glic michael.pgm
+##############################
-
+# Special flags for this entry
-# Best Abuse of User
+##############################
 #
-briddlebane: briddlebane.c
+ENTRY= primenum
-	${CC} ${CFLAGS} $? -o $@ -lm
+PROG= ${ENTRY}
-
-briddlebane.orig: briddlebane.orig.c
-	${CC} ${CFLAGS} $? -o $@ -lm
-
-# Best Layout
 #
-dhyang: dhyang.c
+OBJ= ${PROG}.o
-	${CC} ${CFLAGS} $? -o $@
+DATA=
-
+TARGET= ${PROG}
-dmy2jd: dmy2jd.c
-	${CC} ${CFLAGS} $? -o $@
-
-# Best of Show
 #
-jarijyrki: jarijyrki.c
+ALT_OBJ=
-	${CC} ${X11CCFLAGS} ${CFLAGS} -DNeedFunctionPrototypes \
+ALT_TARGET=
-	    -DU=40 -DT=98 '-Dz=(T+1)*U*U' -DQ=80 -DS=20 -DN=10 -DB=5 -DG=23 \
-	    -Dp=7 '-DM=((p+1)*Q)+S' '-DH=(G*S)+S+S' -DC=XK_Up -DL=XK_Down \
-	    -DO=XK_Left -DV=XK_Right -DR=XK_Escape -D_=XK_BackSpace \
-	    $? -o $@ ${X11LDFLAGS} -lX11
 
-jarijyrki_files: sheet1.info
 
-# Worst Abuse of the Rules
+#################
+# build the entry
+#################
 #
-# NOTE: You will need to adjust this path to the place where Perl has been
+all: data ${TARGET}
-#	installed on your system.  Running "perl -V" may help you locate
-#	this place.
-#
-# The following bit of perl may help determining the values you need:
-#
-#	perl -MConfig -e 'print "$Config{archlibexp}/CORE\n"'
-#
-#
-dlowe: dlowe.c
-	${CC} ${NO_ANSI_CFLAGS} -DPERL_POLLUTE \
-		`${PERL} -MExtUtils::Embed -e ccopts` $? -o $@ \
-		`${PERL} -MExtUtils::Embed -e ldopts`
-
-# Best Small Program
-#
-natori: natori.c
-	${CC} ${CFLAGS} $? -o $@ -lm
-
-# Astronomically Obfuscated
-#
-rince: rince.c
-	${CC} ${X11CCFLAGS} ${CFLAGS} -DM_PI=3.14159265358979323846 \
-		$? -o $@ -lm ${X11LDFLAGS} -lX11
-
-# Best game
-#
-robison: robison.c
-	${CC} ${CFLAGS} $? -o $@
-
-# Most Portable Output
-#
-thadgavin: thadgavin.c
-	${CC} ${CFLAGS} $? -o $@ -lcurses -lm
-
-thadgavin.orig: thadgavin.orig.c
-	${CC} ${CFLAGS} $? -o $@ -lncurses -lm
-
-# Most Complete Program
-#
-tomx: tomx.c
-	${CC} ${CFLAGS} $? -o $@
-
-everything: ${WINNERS} ${ALT_NAMES} ${DATA_FILES}
-
-clean:
-	${RM} -f *.o a.out core ${WINNERS}
-
-clobber: clean
-	${RM} -f ${WINNERS}
-	${RM} -f ${ALT_NAMES}
-
-nuke: clobber
 	@${TRUE}
 
-install: all
+.PHONY: all alt data everything clean clobber install \
-	${CAT} ${WINNERS} ${ALT_NAMES} > /dev/null
+	love haste waste maker easter_egg sandwich \
+	supernova deep_magic magic charon pluto
+
+${PROG}: ${PROG}.c
+	${CC} ${CFLAGS} $< -o $@ ${LIBS}
+
+# alternative executable
+#
+alt: data ${ALT_TARGET}
+	@${TRUE}
+
+# data files
+#
+data: ${DATA}
+	@${TRUE}
+
+# both all and alt
+#
+everything: all alt
+
+
+###############
+# utility rules
+###############
+#
+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_TARGET}
+	@-if [ -e sandwich ]; then \
+	    ${RM} -f sandwich; \
+	    echo 'ate sandwich'; \
+	fi
+
+install:
+	@echo "Dr. Spock says that is not logical!"
+	@${TRUE}
+
+# you may be able to misunderstand the source by reading indent.c
+#
+indent.c: ${PROG}.c
+	@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
+
+
+##################
+# 133t hacker rulz
+##################
+#
+love:
+	@echo 'not war?'
+	@${TRUE}
+
+haste:
+	$(MAKE) waste
+	@${TRUE}
+
+waste:
+	@echo 'haste'
+	@${TRUE}
+
+maker:
+	@echo 'Participate in a maker faire'
+	@${TRUE}
+
+easter_egg:
+	@echo "you expected to often misunderstand this $${RANDOM} magic"
+	@echo "chongo '<was here>' /\\oo/\\"
+	@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: 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: supernova
+	@-if [ -r .code_anal ]; then \
+	    ccode_analysis --deep_magic 7889066cdbdf09b0408021754586e895be641cc9be29e7eafd3ca65359541f17 \
+	    		   --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
+	else \
+	    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 --level 20003 --mode 5717175 --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
+	else \
+	    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"
+

2000/primenum/README.md

@@ -1,75 +1,82 @@
-Best Abuse of CPP:
+# Best Abuse of CPP:
 
     Raymond Cheong
     [address subject to change]
     MD, USA
 
+# To build:
 
-Judges' Comments:
+```sh
+make
+```
 
-    To build:
+### To run:
 
-	make primenum
+```sh
+./primenum n 
+```
+NOTE: n is an integer.
 
-    To run:
+### Try:
 
-	./primenum n (where n is an integer)
+```sh
+./primenum 23209
+```
 
-    Don't read the author comments until you're ready for the spoiler.
+## Judges' comments:
-    Just stop and read the program; it won't take long.  Once you've figured
-    out what it does, run it.  It may surprise you.
 
-    This entry won, not because the obfuscation is impenetrable, but because
+Don't read the author comments until you're ready for the spoiler.
-    it successfully fooled half of the judges, including me.
+Just stop and read the program; it won't take long.  Once you've figured
+out what it does, run it.  It may surprise you.
 
+This entry won, not because the obfuscation is impenetrable, but because
+it successfully fooled half of the judges, including me.
 
-Selected Author's Comments:
+## Author's comments:
 
-    Description
+### Description
-    ===========
 
-    For 15 years, IOCCC winners have obfuscated programs using esoteric,
+For 15 years, IOCCC winners have obfuscated programs using esoteric,
-    difficult-to-interpret, confusing algorithms.  This entry finally bucks
+difficult-to-interpret, confusing algorithms.  This entry finally bucks
-    that trend and obfuscates in the most "obvious" way possible: by
+that trend and obfuscates in the most "obvious" way possible: by
-    painstakenly describing the algorithm in clear pseudocode.  Even novice
+painstakenly describing the algorithm in clear pseudocode.  Even novice
-    programmers will recognize that the program should find and print prime
+programmers will recognize that the program should find and print prime
-    numbers up to a given number (as specified on the command line).
+numbers up to a given number (as specified on the command line).
 
-    But novice programmers especially know that mistakes are often made in
+But novice programmers especially know that mistakes are often made in
-    translating pseudocode to real code, often resulting in programs with
+translating pseudocode to real code, often resulting in programs with
-    unexpected and confusing output.  Clearly, the program contains several
+unexpected and confusing output.  Clearly, the program contains several
-    syntax "mistakes" (e.g. LessThanOrEqualTo) and blatant "errors" (e.g.
+syntax "mistakes" (e.g. LessThanOrEqualTo) and blatant "errors" (e.g.
-    Zero).  This program clearly requires "debugging."
+Zero).  This program clearly requires "debugging."
 
-    As a result of these "bugs", the program does not primes at all.
+As a result of these "bugs", the program does not primes at all.
-    Instead, the program reads input from stdin and returns garbled text on
+Instead, the program reads input from stdin and returns garbled text on
-    stdout.  Fortunately, you can recover the original message simply by
+stdout.  Fortunately, you can recover the original message simply by
-    running the program a second time.  Try:
+running the program a second time.  Try:
 
-        ./primenum n < textfile | ./primenum n > textfile2
+    ./primenum n < textfile | ./primenum n > textfile2
-        diff textfile textfile2
+    diff textfile textfile2
 
-    where n is the same number (modulo 64).  So, the prime number generator
+where n is the same number (modulo 64).  So, the prime number generator
-    is actually a simple text encoder/decoder!  Of course, don't forget that
+is actually a simple text encoder/decoder!  Of course, don't forget that
-    argument, otherwise the "bugs" in the program will cause it to crash!
+argument, otherwise the "bugs" in the program will cause it to crash!
 
-    Features
+### Features
-    ========
 
-    - The program attempts to mislead the reader into thinking that it
+- The program attempts to mislead the reader into thinking that it
-      generates prime numbers.  It does this by
+  generates prime numbers.  It does this by
-        o describing a correct algorithm in pseudocode,
+    o describing a correct algorithm in pseudocode,
-        o using partially correct conversion of pseudocode to real code,
+    o using partially correct conversion of pseudocode to real code,
-        o using suggestive variable names, and
+    o using suggestive variable names, and
-        o using a suggestive program name.
+    o using a suggestive program name.
-    - The program demonstrates a novel method of abusing the C preprocessor.
+- The program demonstrates a novel method of abusing the C preprocessor.
-    - How the filter algorithm works is left as an exercise to the reader.
+- How the filter algorithm works is left as an exercise to the reader.
-    - OK, so running it through the preprocessor strips away the prime
+- OK, so running it through the preprocessor strips away the prime
-      number front.  But ye be warned: not a11 variab1es1es are identica1 :-)
+  number front.  But ye be warned: not a11 variab1es1es are identica1 :-)
-    - Other features include
+- Other features include
-        o useless variables
+    o useless variables
-        o useless if
+    o useless if
-        o a for loop that's used as an if statement
+    o a for loop that's used as an if statement
-        o dependence on the high bit being 0
+    o dependence on the high bit being 0
-    - Try also
+- Try also
-      echo THIS MESSAGE IS IN ALL CAPS | primenum 32
+  echo THIS MESSAGE IS IN ALL CAPS | ./primenum 32