Report "<stdin>" or "<stdout>" when using "-" as a filename placeholder (#1297)

Also fix a memory leak with `targetFileNames`

include/asm/output.hpp

@@ -10,7 +10,7 @@
 struct Expression;
 struct FileStackNode;
 
-extern char *objectName;
+extern const char *objectName;
 extern struct Section *sectionList;
 
 void out_RegisterNode(struct FileStackNode *node);

include/link/main.hpp

@@ -64,18 +64,4 @@ void error(struct FileStackNode const *where, uint32_t lineNo,
 [[noreturn]] void fatal(struct FileStackNode const *where, uint32_t lineNo,
 		     char const *fmt, ...) format_(printf, 3, 4);
 
-/*
- * Opens a file if specified, and aborts on error.
- * @param fileName The name of the file to open; if NULL, no file will be opened
- * @param mode The mode to open the file with
- * @return A pointer to a valid FILE structure, or NULL if fileName was NULL
- */
-FILE *openFile(char const *fileName, char const *mode);
-
-#define closeFile(file) do { \
-				FILE *tmp = file; \
-				if (tmp) \
-					fclose(tmp); \
-			} while (0)
-
 #endif // RGBDS_LINK_MAIN_H

src/asm/main.cpp

@@ -259,7 +259,7 @@ int main(int argc, char *argv[])
 				dependFileName = musl_optarg;
 			}
 			if (dependfile == NULL)
-				err("Failed to open dependfile %s", dependFileName);
+				err("Failed to open dependfile \"%s\"", dependFileName);
 			break;
 
 		case 'o':
@@ -362,8 +362,9 @@ int main(int argc, char *argv[])
 				memcpy(&targetFileName[targetFileNameLen], newTarget, newTargetLen);
 				if (depType == 'Q')
 					free(newTarget);
-				targetFileNameLen += newTargetLen;
+				if (targetFileNameLen > 0)
 					targetFileName[targetFileNameLen - 1] = ' ';
+				targetFileNameLen += newTargetLen;
 				break;
 			}
 			break;
@@ -376,10 +377,8 @@ int main(int argc, char *argv[])
 		}
 	}
 
-	if (targetFileName == NULL)
-		targetFileName = objectName;
-	else
-		targetFileName[targetFileNameLen - 1] = '\0'; // Overwrite the last space
+	if (!targetFileName && objectName)
+		targetFileName = strdup(objectName);
 
 	if (argc == musl_optind) {
 		fputs("FATAL: Please specify an input file (pass `-` to read from standard input)\n", stderr);
@@ -415,6 +414,7 @@ int main(int argc, char *argv[])
 
 	if (dependfile)
 		fclose(dependfile);
+	free(targetFileName);
 
 	sect_CheckUnionClosed();
 

src/asm/output.cpp

@@ -42,7 +42,7 @@ struct Assertion {
 	struct Assertion *next;
 };
 
-char *objectName;
+const char *objectName;
 
 struct Section *sectionList;
 
@@ -480,13 +480,15 @@ static void registerUnregisteredSymbol(struct Symbol *symbol, void *)
 void out_WriteObject(void)
 {
 	FILE *f;
-	if (strcmp(objectName, "-") != 0)
-		f = fopen(objectName, "wb");
-	else
-		f = fdopen(STDOUT_FILENO, "wb");
 
+	if (strcmp(objectName, "-")) {
+		f = fopen(objectName, "wb");
+	} else {
+		objectName = "<stdout>";
+		f = fdopen(STDOUT_FILENO, "wb");
+	}
 	if (!f)
-		err("Couldn't write file '%s'", objectName);
+		err("Failed to open object file '%s'", objectName);
 
 	// Also write symbols that weren't written above
 	sym_ForEach(registerUnregisteredSymbol, NULL);

src/link/main.cpp

@@ -142,25 +142,6 @@ void argErr(char flag, char const *fmt, ...)
 	exit(1);
 }
 
-FILE *openFile(char const *fileName, char const *mode)
-{
-	if (!fileName)
-		return NULL;
-
-	FILE *file;
-	if (strcmp(fileName, "-") != 0)
-		file = fopen(fileName, mode);
-	else if (mode[0] == 'r')
-		file = fdopen(STDIN_FILENO, mode);
-	else
-		file = fdopen(STDOUT_FILENO, mode);
-
-	if (!file)
-		err("Failed to open file \"%s\"", fileName);
-
-	return file;
-}
-
 // Short options
 static const char *optstring = "dl:m:Mn:O:o:p:S:s:tVvWwx";
 

src/link/object.cpp

@@ -446,13 +446,14 @@ void obj_ReadFile(char const *fileName, unsigned int fileID)
 {
 	FILE *file;
 
-	if (strcmp("-", fileName) != 0)
+	if (strcmp(fileName, "-")) {
 		file = fopen(fileName, "rb");
-	else
+	} else {
+		fileName = "<stdin>";
 		file = fdopen(STDIN_FILENO, "rb"); // `stdin` is in text mode by default
-
+	}
 	if (!file)
-		err("Failed to open file %s", fileName);
+		err("Failed to open file \"%s\"", fileName);
 
 	// First, check if the object is a RGBDS object or a SDCC one. If the first byte is 'R',
 	// we'll assume it's a RGBDS object file, and otherwise, that it's a SDCC object file.
@@ -495,13 +496,11 @@ void obj_ReadFile(char const *fileName, unsigned int fileID)
 	 && matchedElems != strlen(RGBDS_OBJECT_VERSION_STRING))
 		errx("%s: Not a RGBDS object file", fileName);
 
-	verbosePrint("Reading object file %s\n",
-		     fileName);
+	verbosePrint("Reading object file %s\n", fileName);
 
 	uint32_t revNum;
 
-	tryReadlong(revNum, file, "%s: Cannot read revision number: %s",
-		    fileName);
+	tryReadlong(revNum, file, "%s: Cannot read revision number: %s", fileName);
 	if (revNum != RGBDS_OBJECT_REV)
 		errx("%s: Unsupported object file for rgblink %s; try rebuilding \"%s\"%s"
 			" (expected revision %d, got %d)", fileName, get_package_version_string(),
@@ -511,10 +510,8 @@ void obj_ReadFile(char const *fileName, unsigned int fileID)
 	uint32_t nbSymbols;
 	uint32_t nbSections;
 
-	tryReadlong(nbSymbols, file, "%s: Cannot read number of symbols: %s",
-		    fileName);
-	tryReadlong(nbSections, file, "%s: Cannot read number of sections: %s",
-		    fileName);
+	tryReadlong(nbSymbols, file, "%s: Cannot read number of symbols: %s", fileName);
+	tryReadlong(nbSections, file, "%s: Cannot read number of sections: %s", fileName);
 
 	nbSectionsToAssign += nbSections;
 
@@ -622,8 +619,7 @@ void obj_ReadFile(char const *fileName, unsigned int fileID)
 
 	uint32_t nbAsserts;
 
-	tryReadlong(nbAsserts, file, "%s: Cannot read number of assertions: %s",
-		    fileName);
+	tryReadlong(nbAsserts, file, "%s: Cannot read number of assertions: %s", fileName);
 	verbosePrint("Reading %" PRIu32 " assertions...\n", nbAsserts);
 	for (uint32_t i = 0; i < nbAsserts; i++) {
 		struct Assertion *assertion = (struct Assertion *)malloc(sizeof(*assertion));

src/link/output.cpp

@@ -231,8 +231,27 @@ static void writeBank(struct SortedSection *bankSections, uint16_t baseOffset,
 // Writes a ROM file to the output.
 static void writeROM(void)
 {
-	outputFile = openFile(outputFileName, "wb");
-	overlayFile = openFile(overlayFileName, "rb");
+	if (outputFileName) {
+		if (strcmp(outputFileName, "-")) {
+			outputFile = fopen(outputFileName, "wb");
+		} else {
+			outputFileName = "<stdout>";
+			outputFile = fdopen(STDOUT_FILENO, "wb");
+		}
+		if (!outputFile)
+			err("Failed to open output file \"%s\"", outputFileName);
+	}
+
+	if (overlayFile) {
+		if (strcmp(overlayFileName, "-")) {
+			overlayFile = fopen(overlayFileName, "rb");
+		} else {
+			overlayFileName = "<stdin>";
+			overlayFile = fdopen(STDIN_FILENO, "rb");
+		}
+		if (!overlayFile)
+			err("Failed to open overlay file \"%s\"", overlayFileName);
+	}
 
 	uint32_t nbOverlayBanks = checkOverlaySize();
 
@@ -249,8 +268,10 @@ static void writeROM(void)
 				  sectionTypeInfo[SECTTYPE_ROMX].startAddr, sectionTypeInfo[SECTTYPE_ROMX].size);
 	}
 
-	closeFile(outputFile);
-	closeFile(overlayFile);
+	if (outputFile)
+		fclose(outputFile);
+	if (overlayFile)
+		fclose(overlayFile);
 }
 
 /*
@@ -555,7 +576,12 @@ static void writeSym(void)
 	if (!symFileName)
 		return;
 
-	symFile = openFile(symFileName, "w");
+	if (strcmp(symFileName, "-")) {
+		symFile = fopen(symFileName, "w");
+	} else {
+		symFileName = "<stdout>";
+		symFile = fdopen(STDOUT_FILENO, "w");
+	}
 	if (!symFile)
 		err("Failed to open sym file \"%s\"", symFileName);
 
@@ -568,7 +594,7 @@ static void writeSym(void)
 			writeSymBank(&sections[type].banks[bank], type, bank);
 	}
 
-	closeFile(symFile);
+	fclose(symFile);
 }
 
 // Writes the map file, if applicable.
@@ -577,7 +603,12 @@ static void writeMap(void)
 	if (!mapFileName)
 		return;
 
-	mapFile = openFile(mapFileName, "w");
+	if (strcmp(mapFileName, "-")) {
+		mapFile = fopen(mapFileName, "w");
+	} else {
+		mapFileName = "<stdout>";
+		mapFile = fdopen(STDOUT_FILENO, "w");
+	}
 	if (!mapFile)
 		err("Failed to open map file \"%s\"", mapFileName);
 
@@ -590,7 +621,7 @@ static void writeMap(void)
 			writeMapBank(&sections[type].banks[bank], type, bank);
 	}
 
-	closeFile(mapFile);
+	fclose(mapFile);
 }
 
 static void cleanupSections(struct SortedSection *section)