Use log_* functions for tools

Replace all remaining uses of `dbg_msg` function in tools with `log_*` functions.

Add and consistently use `TOOL_NAME` constant for each tool.

Author: Robyt3

src/tools/config_common.h

@@ -1,4 +1,3 @@
-#include <base/dbg.h>
 #include <base/fs.h>
 #include <base/logger.h>
 #include <base/os.h>
@@ -19,20 +18,20 @@ inline void ProcessItem(const char *pItemName, IStorage *pStorage)
 	size_t Len = (size_t)str_length(pItemName) + 1; // including '\0'
 	if(Len > sizeof(aConfig))
 	{
-		dbg_msg("config_common", "can't process overlong filename '%s'", pItemName);
+		log_error(TOOL_NAME, "can't process overlong filename '%s'", pItemName);
 		return;
 	}
 
 	if(!str_endswith(pItemName, ".map"))
 	{
-		dbg_msg("config_common", "can't process non-map file '%s'", pItemName);
+		log_error(TOOL_NAME, "can't process non-map file '%s'", pItemName);
 		return;
 	}
 
 	str_copy(aConfig, pItemName);
 	aConfig[Len - sizeof(".map")] = 0;
 	str_append(aConfig, ".cfg");
-	dbg_msg("config_common", "processing '%s'", pItemName);
+	log_info(TOOL_NAME, "processing '%s'", pItemName);
 	Process(pStorage, pItemName, aConfig);
 }
 
@@ -57,14 +56,14 @@ int main(int argc, const char **argv) // NOLINT(misc-definitions-in-headers)
 	std::unique_ptr<IStorage> pStorage = CreateLocalStorage();
 	if(!pStorage)
 	{
-		log_error("config_common", "Error creating local storage");
+		log_error(TOOL_NAME, "Error creating local storage");
 		return -1;
 	}
 
 	if(argc == 1)
 	{
-		dbg_msg("usage", "%s FILE1 [ FILE2... ]", argv[0]);
-		dbg_msg("usage", "%s DIRECTORY", argv[0]);
+		log_error(TOOL_NAME, "Usage: %s FILE1 [ FILE2... ]", argc > 0 ? argv[0] : TOOL_NAME);
+		log_error(TOOL_NAME, "Usage: %s DIRECTORY", argc > 0 ? argv[0] : TOOL_NAME);
 		return -1;
 	}
 	else if(argc == 2 && fs_is_dir(argv[1]))

src/tools/config_retrieve.cpp

@@ -1,19 +1,21 @@
-#include <base/dbg.h>
 #include <base/fs.h>
 #include <base/io.h>
+#include <base/log.h>
 #include <base/str.h>
 
 #include <engine/shared/datafile.h>
 #include <engine/storage.h>
 
 #include <game/mapitems.h>
 
+static constexpr const char *const TOOL_NAME = "config_retrieve";
+
 static void Process(IStorage *pStorage, const char *pMapName, const char *pConfigName)
 {
 	CDataFileReader Reader;
 	if(!Reader.Open(pStorage, pMapName, IStorage::TYPE_ABSOLUTE))
 	{
-		dbg_msg("config_retrieve", "error opening map '%s'", pMapName);
+		log_error(TOOL_NAME, "Failed to open map '%s' for reading", pMapName);
 		return;
 	}
 	bool ConfigFound = false;
@@ -36,7 +38,7 @@ static void Process(IStorage *pStorage, const char *pMapName, const char *pConfi
 		IOHANDLE Config = pStorage->OpenFile(pConfigName, IOFLAG_WRITE, IStorage::TYPE_ABSOLUTE);
 		if(!Config)
 		{
-			dbg_msg("config_retrieve", "error opening config for writing '%s'", pConfigName);
+			log_error(TOOL_NAME, "Failed to open config '%s' for writing", pConfigName);
 			Reader.Close();
 			return;
 		}

src/tools/config_store.cpp

@@ -12,12 +12,14 @@
 #include <algorithm>
 #include <vector>
 
+static constexpr const char *const TOOL_NAME = "config_store";
+
 static void Process(IStorage *pStorage, const char *pMapName, const char *pConfigName)
 {
 	CLineReader LineReader;
 	if(!LineReader.OpenFile(pStorage->OpenFile(pConfigName, IOFLAG_READ, IStorage::TYPE_ABSOLUTE)))
 	{
-		log_error("config_store", "Failed to import settings from '%s': could not open config for reading", pConfigName);
+		log_error(TOOL_NAME, "Failed to import settings from '%s': failed to open config for reading", pConfigName);
 		return;
 	}
 
@@ -32,7 +34,7 @@ static void Process(IStorage *pStorage, const char *pMapName, const char *pConfi
 	CDataFileReader Reader;
 	if(!Reader.Open(pStorage, pMapName, IStorage::TYPE_ABSOLUTE))
 	{
-		log_error("config_store", "Failed to import settings from '%s': failed to open map '%s' for reading", pConfigName, pMapName);
+		log_error(TOOL_NAME, "Failed to import settings from '%s': failed to open map '%s' for reading", pConfigName, pMapName);
 		return;
 	}
 
@@ -71,7 +73,7 @@ static void Process(IStorage *pStorage, const char *pMapName, const char *pConfi
 					int DataSize = Reader.GetDataSize(SettingsIndex);
 					if(DataSize == TotalLength && mem_comp(pSettings, pMapSettings, DataSize) == 0)
 					{
-						log_info("config_store", "Configs coincide, not updating map");
+						log_info(TOOL_NAME, "Configs coincide, not updating map");
 						free(pSettings);
 						return;
 					}
@@ -125,10 +127,10 @@ static void Process(IStorage *pStorage, const char *pMapName, const char *pConfi
 	Reader.Close();
 	if(!Writer.Open(pStorage, pMapName))
 	{
-		log_error("config_store", "Failed to import settings from '%s': failed to open map '%s' for writing", pConfigName, pMapName);
+		log_error(TOOL_NAME, "Failed to import settings from '%s': failed to open map '%s' for writing", pConfigName, pMapName);
 		return;
 	}
 	Writer.Finish();
-	log_info("config_store", "Imported settings from '%s' into '%s'", pConfigName, pMapName);
+	log_info(TOOL_NAME, "Imported settings from '%s' into '%s'", pConfigName, pMapName);
 }
 #include "config_common.h"

src/tools/crapnet.cpp

@@ -1,6 +1,6 @@
 /* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
 /* If you are missing that file, acquire a complete release at teeworlds.com.                */
-#include <base/dbg.h>
+
 #include <base/logger.h>
 #include <base/mem.h>
 #include <base/net.h>
@@ -11,6 +11,8 @@
 #include <iterator> // std::size
 #include <thread>
 
+static constexpr const char *const TOOL_NAME = "crapnet";
+
 struct SPacket
 {
 	SPacket *m_pPrev;
@@ -64,7 +66,7 @@ static void Run(unsigned short Port, NETADDR Dest)
 		SPingConfig Ping = g_aConfigPings[n];
 
 		if(n != s_Lastcfg)
-			dbg_msg("crapnet", "cfg = %d", n);
+			log_info(TOOL_NAME, "cfg = %d", n);
 		s_Lastcfg = n;
 
 		// handle incoming packets
@@ -81,7 +83,7 @@ static void Run(unsigned short Port, NETADDR Dest)
 			if((rand() % 100) < Ping.m_Loss) // drop the packet
 			{
 				if(g_ConfigLog)
-					dbg_msg("crapnet", "dropped packet");
+					log_info(TOOL_NAME, "dropped packet");
 				continue;
 			}
 
@@ -137,7 +139,7 @@ static void Run(unsigned short Port, NETADDR Dest)
 			{
 				char aAddrStr[NETADDR_MAXSTRSIZE];
 				net_addr_str(&From, aAddrStr, sizeof(aAddrStr), true);
-				dbg_msg("crapnet", "<< %08d %s (%d)", p->m_Id, aAddrStr, p->m_DataSize);
+				log_info(TOOL_NAME, "<< %08d %s (%d)", p->m_Id, aAddrStr, p->m_DataSize);
 			}
 		}
 
@@ -189,7 +191,7 @@ static void Run(unsigned short Port, NETADDR Dest)
 				{
 					char aAddrStr[NETADDR_MAXSTRSIZE];
 					net_addr_str(&p->m_SendTo, aAddrStr, sizeof(aAddrStr), true);
-					dbg_msg("crapnet", ">> %08d %s (%d) %s", p->m_Id, aAddrStr, p->m_DataSize, aFlags);
+					log_info(TOOL_NAME, ">> %08d %s (%d) %s", p->m_Id, aAddrStr, p->m_DataSize, aFlags);
 				}
 
 				free(p);

src/tools/demo_extract_chat.cpp

@@ -15,7 +15,7 @@
 
 #include <memory>
 
-static const char *TOOL_NAME = "demo_extract_chat";
+static constexpr const char *const TOOL_NAME = "demo_extract_chat";
 
 class CClientSnapshotHandler
 {
@@ -282,7 +282,7 @@ int main(int argc, const char *argv[])
 
 	if(argc != 2)
 	{
-		log_error(TOOL_NAME, "Usage: %s <demo_filename>", TOOL_NAME);
+		log_error(TOOL_NAME, "Usage: %s <demo_filename>", argc > 0 ? argv[0] : TOOL_NAME);
 		return -1;
 	}
 

src/tools/dilate.cpp

@@ -9,6 +9,8 @@
 #include <engine/gfx/image_loader.h>
 #include <engine/gfx/image_manipulation.h>
 
+static constexpr const char *const TOOL_NAME = "dilate";
+
 static bool DilateFile(const char *pFilename, bool DryRun)
 {
 	CImageInfo Image;
@@ -18,7 +20,7 @@ static bool DilateFile(const char *pFilename, bool DryRun)
 
 	if(Image.m_Format != CImageInfo::FORMAT_RGBA)
 	{
-		log_error("dilate", "ERROR: only RGBA PNG images are supported");
+		log_error(TOOL_NAME, "Only RGBA PNG images are supported");
 		Image.Free();
 		return false;
 	}
@@ -30,7 +32,7 @@ static bool DilateFile(const char *pFilename, bool DryRun)
 		const bool EqualImages = Image.DataEquals(OldImage);
 		Image.Free();
 		OldImage.Free();
-		log_info("dilate", "'%s' is %sdilated", pFilename, EqualImages ? "" : "NOT ");
+		log_info(TOOL_NAME, "'%s' is %sdilated", pFilename, EqualImages ? "" : "NOT ");
 		return EqualImages;
 	}
 	else
@@ -49,14 +51,14 @@ int main(int argc, const char **argv)
 
 	if(argc == 1)
 	{
-		log_error("dilate", "Usage: %s [--dry-run] <image1.png> [<image2.png> ...]", argv[0]);
+		log_error(TOOL_NAME, "Usage: %s [--dry-run] <image1.png> [<image2.png> ...]", argc > 0 ? argv[0] : TOOL_NAME);
 		return -1;
 	}
 
 	const bool DryRun = str_comp(argv[1], "--dry-run") == 0;
 	if(DryRun && argc < 3)
 	{
-		log_error("dilate", "Usage: %s [--dry-run] <image1.png> [<image2.png> ...]", argv[0]);
+		log_error(TOOL_NAME, "Usage: %s [--dry-run] <image1.png> [<image2.png> ...]", argc > 0 ? argv[0] : TOOL_NAME);
 		return -1;
 	}
 

src/tools/dummy_map.cpp

@@ -1,4 +1,3 @@
-#include <base/dbg.h>
 #include <base/hash.h>
 #include <base/logger.h>
 #include <base/os.h>
@@ -11,7 +10,7 @@
 
 #include <zlib.h>
 
-static const char *TOOL_NAME = "dummy_map";
+static constexpr const char *const TOOL_NAME = "dummy_map";
 
 static void CreateEmptyMap(IStorage *pStorage)
 {

src/tools/map_convert_07.cpp

@@ -1,7 +1,6 @@
 /* (c) DDNet developers. See licence.txt in the root of the distribution for more information. */
 /* If you are missing that file, acquire a complete release at teeworlds.com.  */
 
-#include <base/dbg.h>
 #include <base/fs.h>
 #include <base/io.h>
 #include <base/logger.h>
@@ -17,9 +16,7 @@
 
 #include <utility>
 
-/*
-	Usage: map_convert_07 <source map filepath> <dest map filepath>
-*/
+static constexpr const char *const TOOL_NAME = "map_convert_07";
 
 static CDataFileReader g_DataReader;
 static CDataFileWriter g_DataWriter;
@@ -59,7 +56,7 @@ static bool CheckImageDimensions(void *pLayerItem, int LayerType, const char *pF
 	IntsToStr(pTMap->m_aName, std::size(pTMap->m_aName), aTileLayerName, std::size(aTileLayerName));
 
 	const char *pName = g_DataReader.GetDataString(pImgItem->m_ImageName);
-	dbg_msg("map_convert_07", "%s: Tile layer \"%s\" uses image \"%s\" with width %d, height %d, which is not divisible by 16. This is not supported in Teeworlds 0.7. Please scale the image and replace it manually.", pFilename, aTileLayerName, pName == nullptr ? "(error)" : pName, pImgItem->m_Width, pImgItem->m_Height);
+	log_error(TOOL_NAME, "%s: Tile layer \"%s\" uses image \"%s\" with width %d, height %d, which is not divisible by 16. This is not supported in Teeworlds 0.7. Please scale the image and replace it manually.", pFilename, aTileLayerName, pName == nullptr ? "(error)" : pName, pImgItem->m_Width, pImgItem->m_Height);
 	return false;
 }
 
@@ -71,11 +68,11 @@ static void *ReplaceImageItem(int Index, CMapItemImage *pImgItem, CMapItemImage
 	const char *pName = g_DataReader.GetDataString(pImgItem->m_ImageName);
 	if(pName == nullptr || pName[0] == '\0')
 	{
-		dbg_msg("map_convert_07", "failed to load name of image %d", Index);
+		log_error(TOOL_NAME, "failed to load name of image %d", Index);
 		return pImgItem;
 	}
 
-	dbg_msg("map_convert_07", "embedding image '%s'", pName);
+	log_info(TOOL_NAME, "embedding image '%s'", pName);
 
 	char aStr[IO_MAX_PATH_LENGTH];
 	str_format(aStr, sizeof(aStr), "data/mapres/%s.png", pName);
@@ -88,7 +85,7 @@ static void *ReplaceImageItem(int Index, CMapItemImage *pImgItem, CMapItemImage
 	const size_t MaxImageDimension = 1 << 13;
 	if(ImgInfo.m_Format != CImageInfo::FORMAT_RGBA || ImgInfo.m_Width > MaxImageDimension || ImgInfo.m_Height > MaxImageDimension)
 	{
-		dbg_msg("map_convert_07", "ERROR: only RGBA PNG images with maximum width/height %" PRIzu " are supported", MaxImageDimension);
+		log_error(TOOL_NAME, "only RGBA PNG images with maximum width/height %" PRIzu " are supported", MaxImageDimension);
 		ImgInfo.Free();
 		return pImgItem;
 	}
@@ -113,15 +110,15 @@ int main(int argc, const char **argv)
 
 	if(argc < 2 || argc > 3)
 	{
-		dbg_msg("map_convert_07", "Invalid arguments");
-		dbg_msg("map_convert_07", "Usage: map_convert_07 <source map filepath> [<dest map filepath>]");
+		log_error(TOOL_NAME, "Invalid arguments");
+		log_error(TOOL_NAME, "Usage: %s <source map filepath> [<dest map filepath>]", argc > 0 ? argv[0] : TOOL_NAME);
 		return -1;
 	}
 
 	std::unique_ptr<IStorage> pStorage = std::unique_ptr<IStorage>(CreateStorage(IStorage::EInitializationType::BASIC, argc, argv));
 	if(!pStorage)
 	{
-		log_error("map_convert_07", "Error creating basic storage");
+		log_error(TOOL_NAME, "Error creating basic storage");
 		return -1;
 	}
 
@@ -139,26 +136,26 @@ int main(int argc, const char **argv)
 		str_format(aDestFilename, sizeof(aDestFilename), "data/maps7/%s.map", aBuf);
 		if(fs_makedir("data") != 0)
 		{
-			dbg_msg("map_convert_07", "failed to create data directory");
+			log_error(TOOL_NAME, "failed to create data directory");
 			return -1;
 		}
 
 		if(fs_makedir("data/maps7") != 0)
 		{
-			dbg_msg("map_convert_07", "failed to create data/maps7 directory");
+			log_error(TOOL_NAME, "failed to create data/maps7 directory");
 			return -1;
 		}
 	}
 
 	if(!g_DataReader.Open(pStorage.get(), pSourceFilename, IStorage::TYPE_ABSOLUTE))
 	{
-		dbg_msg("map_convert_07", "failed to open source map. filename='%s'", pSourceFilename);
+		log_error(TOOL_NAME, "failed to open source map. filename='%s'", pSourceFilename);
 		return -1;
 	}
 
 	if(!g_DataWriter.Open(pStorage.get(), aDestFilename, IStorage::TYPE_ABSOLUTE))
 	{
-		dbg_msg("map_convert_07", "failed to open destination map. filename='%s'", aDestFilename);
+		log_error(TOOL_NAME, "failed to open destination map. filename='%s'", aDestFilename);
 		return -1;
 	}
 
@@ -173,7 +170,7 @@ int main(int argc, const char **argv)
 		{
 			if(i >= MAX_MAPIMAGES)
 			{
-				dbg_msg("map_convert_07", "map uses more images than the client maximum of %" PRIzu ". filename='%s'", MAX_MAPIMAGES, pSourceFilename);
+				log_warn(TOOL_NAME, "map uses more images than the client maximum of %" PRIzu ". filename='%s'", MAX_MAPIMAGES, pSourceFilename);
 				break;
 			}
 			g_aImageIds[i] = Index;