Improved diagnostic messages.

The --debug flag now takes either a number or the name of the messages
to show. Ie. one can now use mm --debug verbose to enable messages. All
debug messages above normal will also tell which level they originate
from, so that it is easier to discover the different levels.

Added the new level PEDANTIC to allow for a level that spots suspicious
things which are not always errors that one can use to easily spot
common mistakes. Currently, I added a warning for including files
outside the working directory. These were previously silently
ignored. This is currently the only warning for PEDANTIC, but more will
come as they are needed.

Signed-off-by: Filip Strömbäck <fstromback@gmail.com>

Author: fstromback

src/cmdline.cpp

@@ -35,7 +35,13 @@ static const char *helpStr =
 	"[option]        - use the corresponding section in the config file.\n"
 	"[file]          - input files in addition to those specified in the config.\n"
 	"--output, -o    - specify the name of the output file.\n"
-	"--debug, -d     - specify debug level. 0 = silent, 3 = verbose.\n"
+	"--debug, -d     - specify debug level. One of the following values, or its numerical value:\n"
+	"   QUIET    = 0 - no output except for hard errors.\n"
+	"   NORMAL   = 1 - standard. Outputs progress information.\n"
+	"   PEDANTIC = 2 - warns about suspicious things, which could be errors.\n"
+	"   INFO     = 3 - information about decisions made during the build. Good for debugging.\n"
+	"   VERBOSE  = 4 - all information you will possibly need when debugging your configurations.\n"
+	"   DEBUG    = 5 - information usually only needed when debugging mymake itself.\n"
 	"--exec-path, -p - specify the cwd when running the output.\n"
 	"--help, -?      - show this help.\n"
 	"--force, -f     - always recompile everything.\n"
@@ -256,6 +262,38 @@ bool CmdLine::parseOption(char opt) {
 	return true;
 }
 
+static bool strEq(const String &a, const char *b) {
+	for (nat i = 0; i < a.size(); i++) {
+		if (b[i] == 0)
+			return false;
+
+		if (tolower(a[i]) != tolower(b[i]))
+			return false;
+	}
+
+	if (b[a.size()] != 0)
+		return false;
+
+	return true;
+}
+
+static int findDebugLevel(const String &name) {
+	if (strEq(name, "QUIET"))
+		return dbg_QUIET;
+	if (strEq(name, "NORMAL"))
+		return dbg_NORMAL;
+	if (strEq(name, "PEDANTIC"))
+		return dbg_PEDANTIC;
+	if (strEq(name, "INFO"))
+		return dbg_INFO;
+	if (strEq(name, "VERBOSE"))
+		return dbg_VERBOSE;
+	if (strEq(name, "DEBUG"))
+		return dbg_DEBUG;
+
+	return to<int>(name, -1);
+}
+
 bool CmdLine::optionParam(const String &v) {
 	State s = state;
 	state = sNone;
@@ -269,7 +307,11 @@ bool CmdLine::optionParam(const String &v) {
 		state = sArguments;
 		return true;
 	case sDebug:
-		debugLevel = to<int>(v);
+		debugLevel = findDebugLevel(v);
+		if (debugLevel < 0) {
+			PLN("Invalid value for debug level!");
+			errors = true;
+		}
 		return true;
 	case sExecPath:
 		execPath = Path(v).makeAbsolute();

src/compile.cpp

@@ -103,6 +103,7 @@ namespace compile {
 				}
 
 				// No need to follow further!
+				DEBUG(L"Ignoring file outside of working directory: " << now.makeRelative(wd), PEDANTIC);
 				continue;
 			}
 
@@ -200,7 +201,7 @@ namespace compile {
 
 			if (!force && pchValid && output.exists() && output.mTime() >= lastModified) {
 				DEBUG("Skipping " << src.makeRelative(wd) << "...", INFO);
-				DEBUG("Source modified: " << lastModified << ", output modified " << output.mTime(), VERBOSE);
+				DEBUG("Source modified: " << lastModified << ", output modified " << output.mTime(), DEBUG);
 
 				Timestamp mTime = output.mTime();
 				if (i == 0)
@@ -281,7 +282,7 @@ namespace compile {
 		// Link the output.
 		if (!force && output.exists() && output.mTime() >= latestModified) {
 			DEBUG("Skipping linking.", INFO);
-			DEBUG("Output modified " << output.mTime() << ", input modified " << latestModified, VERBOSE);
+			DEBUG("Output modified " << output.mTime() << ", input modified " << latestModified, DEBUG);
 			return true;
 		}
 
@@ -438,12 +439,12 @@ namespace compile {
 		vector<Path> children = at.children();
 		for (nat i = 0; i < children.size(); i++) {
 			if (children[i].isDir()) {
-				DEBUG("Found directory " << children[i], VERBOSE);
+				DEBUG("Found directory " << children[i], DEBUG);
 				addFilesRecursive(to, children[i]);
 			} else {
-				DEBUG("Found file " << children[i], VERBOSE);
+				DEBUG("Found file " << children[i], DEBUG);
 				if (std::find(validExts.begin(), validExts.end(), children[i].ext()) != validExts.end()) {
-					DEBUG("Adding file " << children[i], INFO);
+					DEBUG("Adding file " << children[i], VERBOSE);
 					to << Compile(children[i], false, true);
 				}
 			}
@@ -496,7 +497,7 @@ namespace compile {
 			if (w.matches(file))
 				return variant.substr(colon + 1);
 
-			DEBUG("No match for " << file << " using " << variant, VERBOSE);
+			DEBUG("No match for " << file << " using " << variant, INFO);
 		}
 
 		return "";

src/includes.cpp

@@ -277,7 +277,7 @@ bool Includes::ignored(const Path &path) const {
 
 	for (nat i = 0; i < ignorePatterns.size(); i++) {
 		if (ignorePatterns[i].matches(t)) {
-			DEBUG(path << " ignored as per " << ignorePatterns[i], VERBOSE);
+			DEBUG(path << " ignored as per " << ignorePatterns[i], INFO);
 			return true;
 		}
 	}

src/mymake.cpp

@@ -12,14 +12,14 @@ int compileTarget(const Path &wd, const CmdLine &cmdline) {
 	// Load the system-global file.
 	Path globalFile(Path::home() + localConfig);
 	if (globalFile.exists()) {
-		DEBUG("Global file found: " << globalFile, INFO);
+		DEBUG("Global file found: " << globalFile, VERBOSE);
 		config.load(globalFile);
 	}
 
 	Path localFile(wd + localConfig);
 	if (localFile.exists()) {
 		config.load(localFile);
-		DEBUG("Local file found: " << localFile, INFO);
+		DEBUG("Local file found: " << localFile, VERBOSE);
 	}
 
 	// Compile plain .mymake-file.
@@ -58,11 +58,11 @@ int compileProject(const Path &wd, const Path &projectFile, const CmdLine &cmdli
 
 	Path globalFile(Path::home() + localConfig);
 	if (globalFile.exists()) {
-		DEBUG("Global file found: " << globalFile, INFO);
+		DEBUG("Global file found: " << globalFile, VERBOSE);
 		config.load(globalFile);
 	}
 
-	DEBUG("Project file found: " << projectFile, INFO);
+	DEBUG("Project file found: " << projectFile, VERBOSE);
 	config.load(projectFile);
 
 	Config params;

src/std.h

@@ -130,9 +130,9 @@ inline set<T> operator +(set<T> a, const set<T> &b) {
 
 // Convert to number.
 template <class T>
-T to(const String &s) {
+T to(const String &s, const T &def = T()) {
 	std::istringstream ss(s);
-	T t = T();
+	T t = def;
 	ss >> t;
 	return t;
 }
@@ -271,16 +271,21 @@ class SetBanner : NoCopy {
 // Debug level.
 enum {
 	dbg_QUIET = 0,
-	dbg_NORMAL = 1,
-	dbg_INFO = 2,
-	dbg_VERBOSE = 3,
-	dbg_DEBUG = 4,
+	dbg_NORMAL,
+	dbg_PEDANTIC,
+	dbg_INFO,
+	dbg_VERBOSE,
+	dbg_DEBUG,
 };
 
 #define DEBUG(x, level)							\
 	do {										\
 		if (debugLevel >= dbg_ ## level) {		\
-			PLN(x);								\
+			if (dbg_ ## level > dbg_NORMAL) {	\
+				PLN(#level ": " << x);			\
+			} else {							\
+				PLN(x);							\
+			}									\
 		}										\
 	} while (false)
 

todo.org

@@ -1,4 +1,9 @@
 * Things to do
+
+  Make sure we process all input from a process that has died. Currently, if a process prints
+  lots of things to stdout and then crashes, sometimes we do not get all of it through mymake.
+  This may be either because mymake exits, or because mymake decides the process is dead and do
+  not need more output.
 
   Move constants used with Config into string constants somewhere.