The quineHEADmaster

10 files changed, 386 insertions, 0 deletions

diff --git a/.clang-format b/.clang-format
new file mode 100644
index 0000000..b58356f
--- /dev/null
+++ b/.clang-format
@@ -0,0 +1,71 @@
+---
+AlignAfterOpenBracket: BlockIndent
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands: Align
+AlignTrailingComments: false
+AllowShortBlocksOnASingleLine: Always
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakBeforeMultilineStrings: false
+BinPackArguments: true
+BinPackParameters: true
+BitFieldColonSpacing: Both
+AlwaysBreakAfterReturnType: None
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Linux
+BreakBeforeTernaryOperators: true
+BreakStringLiterals: false
+ColumnLimit: 85
+ContinuationIndentWidth: 8
+DerivePointerAlignment: false
+DisableFormat: false
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex: '^"'
+    Priority: 1
+  - Regex: '^<'
+    Priority: 2
+IncludeIsMainRegex: '$'
+IndentCaseBlocks: true
+IndentCaseLabels: false
+IndentGotoLabels: false # maybe ...
+IndentPPDirectives: None
+IndentWidth: 8
+IndentWrappedFunctionNames: false
+InsertBraces: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+Language: Cpp
+MaxEmptyLinesToKeep: 1
+PenaltyBreakAssignment: 10
+PenaltyBreakBeforeFirstCallParameter: 30
+PenaltyBreakComment: 10
+PenaltyBreakFirstLessLess: 0
+PenaltyBreakOpenParenthesis: 10
+PenaltyBreakString: 10
+PenaltyExcessCharacter: 60
+PenaltyReturnTypeOnItsOwnLine: 40
+PointerAlignment: Right
+QualifierAlignment: Custom
+QualifierOrder: [ 'static', 'inline', 'const', 'restrict', 'volatile', 'type' ]
+ReflowComments: false
+SortIncludes: CaseInsensitive
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAroundPointerQualifiers: Both
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeParens: ControlStatementsExceptForEachMacros
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpacesBeforeTrailingComments: 1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+TabWidth: 8
+UseCRLF: false
+UseTab: ForContinuationAndIndentation
+...
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0da4e6f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,12 @@
+cquine
+cquine.c
+cquine.out.c
+
+cescape
+combine
+
+*.d
+*.escaped
+*.o
+
+.autoformat
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0a04128
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..34b780b
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2024 Tomasz Kramkowski <tomasz@kramkow.ski>
+# SPDX-LicenseIdentifier: GPL-3.0-or-later
+
+CFLAGS += -std=c11
+
+%.escaped: % cescape Makefile
+	< $< ./cescape > $@
+
+%.c: %.in.c %.in.c.escaped combine Makefile
+	< $< ./combine $*.in.c.escaped > $@
+
+all: cquine
+cquine: cquine.c
+cquine.c: cquine.in.c
+cescape: cescape.c
+combine: combine.c
diff --git a/README b/README
new file mode 100644
index 0000000..a9ec15d
--- /dev/null
+++ b/README
@@ -0,0 +1,7 @@
+My first quine, a bit late in my career, but I felt like doing it one lunch break.
+
+make builds the quine from its constituent parts to make editing it easier.
+
+The resulting `cquine.c` is the source and `cquine` is the quine binary.
+Running `cquine` should result in an output identical to `cquine.c`. You can
+verify this by running `test`.
diff --git a/cescape.c b/cescape.c
new file mode 100644
index 0000000..3fd5ac2
--- /dev/null
+++ b/cescape.c
@@ -0,0 +1,21 @@
+// SPDX-FileCopyrightText: 2024 Tomasz Kramkowski <tomasz@kramkow.ski>
+// SPDX-LicenseIdentifier: GPL-3.0-or-later
+
+// A tool to produce escaped C strings.
+// Only escapes tabs, newlines, double quotes and backslashes.
+
+#include <stdio.h>
+
+int main(void)
+{
+	int c;
+	while (c = getchar(), c != EOF) {
+		switch (c) {
+		case '\t': fputs("\\t", stdout); break;
+		case '\n': fputs("\\n", stdout); break;
+		case '"': fputs("\\\"", stdout); break;
+		case '\\': fputs("\\\\", stdout); break;
+		default: putchar(c); break;
+		}
+	}
+}
diff --git a/clean b/clean
new file mode 100755
index 0000000..09d05b4
--- /dev/null
+++ b/clean
@@ -0,0 +1,3 @@
+#!/bin/sh
+rm -f cquine.c cquine cescape combine cquine.out.c
+find . \( -name '*.o' -o -name '*.escaped' -o -name '*.d' \) -delete
diff --git a/combine.c b/combine.c
new file mode 100644
index 0000000..4629ca7
--- /dev/null
+++ b/combine.c
@@ -0,0 +1,60 @@
+// SPDX-FileCopyrightText: 2024 Tomasz Kramkowski <tomasz@kramkow.ski>
+// SPDX-LicenseIdentifier: GPL-3.0-or-later
+
+// A tool to combine two files by replacing every instance of the character
+// sequence %s with the contents of the file named by the first argument.
+// This tool does not support escaping.
+
+#include <errno.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+static const char *argv0 = "combine";
+
+void dump(FILE *f)
+{
+	if (fseek(f, 0, SEEK_SET) != 0) {
+		fprintf(stderr, "%s: error: Failed to rewind inclusion file: %s",
+			argv0, strerror(errno));
+		exit(EXIT_FAILURE);
+	}
+	int c;
+	while (c = fgetc(f), c != EOF) putchar(c);
+}
+
+int main(int argc, char **argv)
+{
+	if (argv[0] != NULL) argv0 = argv[0];
+	if (argc != 2) {
+		fprintf(stderr, "Usage: %s inclusion\n", argv0);
+		return EXIT_FAILURE;
+	}
+
+	FILE *inclusion = fopen(argv[1], "r");
+	if (inclusion == NULL) {
+		fprintf(stderr, "%s: error: Failed to open \"%s\": %s\n", argv0,
+			argv[1], strerror(errno));
+		return EXIT_FAILURE;
+	}
+
+	bool was_percent = false;
+	int c;
+	while (c = getchar(), c != EOF) {
+		if (was_percent) {
+			was_percent = false;
+			if (c == 's') {
+				dump(inclusion);
+			} else {
+				putchar('%');
+				putchar(c);
+			}
+		} else {
+			if (c == '%')
+				was_percent = true;
+			else
+				putchar(c);
+		}
+	}
+}
diff --git a/cquine.in.c b/cquine.in.c
new file mode 100644
index 0000000..42860c8
--- /dev/null
+++ b/cquine.in.c
@@ -0,0 +1,27 @@
+// SPDX-FileCopyrightText: 2024 Tomasz Kramkowski <tomasz@kramkow.ski>
+// SPDX-LicenseIdentifier: GPL-3.0-or-later
+
+#include <stdio.h>
+#include <string.h>
+
+void escape(char *dest, const char *src)
+{
+	for (size_t i = 0; src[i] != '\0'; i++) {
+		switch (src[i]) {
+		case '\t': *dest++ = '\\'; *dest++ = 't'; break;
+		case '\n': *dest++ = '\\'; *dest++ = 'n'; break;
+		case '"': *dest++ = '\\'; *dest++ = '"'; break;
+		case '\\': *dest++ = '\\'; *dest++ = '\\'; break;
+		default: *dest++ = src[i]; break;
+		}
+	}
+	*dest = '\0';
+}
+
+int main(void)
+{
+	const char *program = "%s";
+	char escaped[strlen(program) * 2 + 1];
+	escape(escaped, program);
+	printf(program, escaped);
+}
diff --git a/test b/test
new file mode 100755
index 0000000..b369126
--- /dev/null
+++ b/test
@@ -0,0 +1,4 @@
+#!/bin/sh
+./cquine >cquine.out.c || exit
+cmp cquine.c cquine.out.c || exit
+echo ok