Convert calls to message that contain a message code to calls to nmessage.

Author: David Betz

src/fastloader.cpp

@@ -171,11 +171,11 @@ int Loader::fastLoadImage(const uint8_t *image, int imageSize, LoadType loadType
     }
 
     /* transmit the image */
-    message("002-Downloading file to port %s", m_connection->portName());
+    nmessage(INFO_DOWNLOADING, m_connection->portName());
     remaining = imageSize;
     while (remaining > 0) {
         int size;
-        progress("008-%ld bytes remaining             ", (long)remaining);
+        nprogress(INFO_BYTES_REMAINING, (long)remaining);
         if ((size = remaining) > m_connection->maxDataSize())
             size = m_connection->maxDataSize();
         if (transmitPacket(packetID, image, size, &result) != 0)
@@ -188,7 +188,7 @@ int Loader::fastLoadImage(const uint8_t *image, int imageSize, LoadType loadType
         image += size;
         --packetID;
     }
-    message("009-%ld bytes sent             ", (long)imageSize);
+    nmessage(INFO_BYTES_SENT, (long)imageSize);
 
     /*
         When we're doing a download that does not include an EEPROM write, the Packet IDs end up as:
@@ -206,7 +206,7 @@ int Loader::fastLoadImage(const uint8_t *image, int imageSize, LoadType loadType
     */
 
     /* transmit the RAM verify packet and verify the checksum */
-    message("003-Verifying RAM");
+    nmessage(INFO_VERIFYING_RAM);
     if (transmitPacket(packetID, verifyRAM, sizeof(verifyRAM), &result) != 0)
         return -1;
     if (result != -checksum) {
@@ -216,7 +216,7 @@ int Loader::fastLoadImage(const uint8_t *image, int imageSize, LoadType loadType
     packetID = -checksum;
 
     if (loadType & ltDownloadAndProgram) {
-        message("004-Programming EEPROM");
+        nmessage(INFO_PROGRAMMING_EEPROM);
         if (transmitPacket(packetID, programVerifyEEPROM, sizeof(programVerifyEEPROM), &result, 8000) != 0)
             return -1;
         if (result != -checksum*2) {

src/main.cpp

@@ -279,21 +279,21 @@ int main(int argc, char *argv[])
     if (file) {
         nmessage(INFO_OPENING_FILE, file);
         if (!(image = Loader::readFile(file, &imageSize))) {
-            message("103-Can't open file '%s'", file);
+            nmessage(ERROR_CANT_OPEN_FILE, file);
             return 1;
         }
         switch (PropImage::validate(image, imageSize)) {
         case PropImage::SUCCESS:
             // success
             break;
         case PropImage::IMAGE_TRUNCATED:
-            message("110-File is truncated or not a Propeller application image");
+            nmessage(ERROR_FILE_TRUNCATED);
             return 1;
         case PropImage::IMAGE_CORRUPTED:
-            message("111-File is corrupt or not a Propeller application");
+            nmessage(ERROR_FILE_CORRUPTED);
             return 1;
         default:
-            message("998-Internal error");
+            nmessage(ERROR_INTERNAL_CODE_ERROR);
             return 1;
         }
     }
@@ -374,24 +374,24 @@ int main(int argc, char *argv[])
     if (useSerial) {
         SerialInfo info; // needs to stay in scope as long as we're using port
         if (!(serialConnection = new SerialPropConnection)) {
-            message("999-Insufficient memory");
+            nmessage(ERROR_INSUFFICIENT_MEMORY);
             return 1;
         }
         if (!port) {
             SerialInfoList ports;
             if (SerialPropConnection::findPorts(PORT_PREFIX, true, ports) != 0) {
-                message("115-Serial port discovery failed");
+                nmessage(ERROR_SERIAL_PORT_DISCOVERY_FAILED);
                 return 1;
             }
             if (ports.size() == 0) {
-                message("116-No serial ports found");
+                nmessage(ERROR_NO_SERIAL_PORTS_FOUND);
                 return 1;
             }
             info = ports.front();
             port = info.port();
         }
         if ((sts = serialConnection->open(port)) != 0) {
-            message("117-Unable to connect to port %s", port);
+            nmessage(ERROR_UNABLE_TO_CONNECT_TO_PORT, port);
             return 1;
         }
         connection = serialConnection;
@@ -400,41 +400,38 @@ int main(int argc, char *argv[])
     /* do a wifi download */
     else {
         if (!(wifiConnection = new WiFiPropConnection)) {
-            message("999-Insufficient memory");
+            nmessage(ERROR_INSUFFICIENT_MEMORY);
             return 1;
         }
         if (!ipaddr) {
             WiFiInfoList addrs;
             if (WiFiPropConnection::findModules(false, addrs, 1) != 0) {
-                message("113-Wifi module discovery failed");
+                nmessage(ERROR_WIFI_MODULE_DISCOVERY_FAILED);
                 return 1;
             }
             if (addrs.size() == 0) {
-                message("114-No wifi modules found");
+                nmessage(ERROR_NO_WIFI_MODULES_FOUND);
                 return 1;
             }
             const char *ipaddr2 = addrs.front().address();
             char *p;
             if (!(p = (char *)malloc(strlen(ipaddr2) + 1))) {
-                message("999-Insufficient memory");
+                nmessage(ERROR_INSUFFICIENT_MEMORY);
                 return 1;
             }
             strcpy(p, ipaddr2);
             ipaddr = p;
         }
         if ((sts = wifiConnection->setAddress(ipaddr)) != 0) {
-            message("101-Invalid address: %s", ipaddr);
+            nmessage(ERROR_INVALID_MODULE_ADDRESS, ipaddr);
             return 1;
         }
         if (wifiConnection->getVersion() != 0) {
-            message("118-Unable to connect to module at %s", ipaddr);
+            nmessage(ERROR_UNABLE_TO_CONNECT_TO_MODULE, ipaddr);
             return 1;
         }
         if ((sts = wifiConnection->checkVersion()) != 0) {
-            message("\
-106-Unrecognized wi-fi module firmware\n\
-    Version is %s but expected %s.\n\
-    Recommended action: update firmware and/or PropLoader to latest version(s).", wifiConnection->version(), WIFI_REQUIRED_MAJOR_VERSION);
+            nmessage(ERROR_WRONG_WIFI_MODULE_FIRMWARE, wifiConnection->version(), WIFI_REQUIRED_MAJOR_VERSION);
             return 1;
         }
         connection = wifiConnection;
@@ -497,25 +494,25 @@ int main(int argc, char *argv[])
 
         /* if we deleted every character then this is an invalid name */
         if (!cleanName[0]) {
-            message("108-Invalid module name");
+            nmessage(ERROR_INVALID_MODULE_NAME);
             return 1;
         }
 
         /* show the clean name if it is different from what the user requested */
         if (strcmp(name, cleanName) != 0)
-            message("010-Setting module name to '%s'", cleanName);
+            nmessage(INFO_SETTING_MODULE_NAME, cleanName);
 
         if (wifiConnection->setName(cleanName) != 0) {
-            message("109-Failed to set module name");
+            nmessage(ERROR_FAILED_TO_SET_MODULE_NAME);
             return 1;
         }
     }
 
     /* write a file to the SD card */
     if (writeFile) {
-        message("007-Writing '%s' to the SD card", file);
+        nmessage(INFO_WRITING_TO_SD_CARD, file);
         if (WriteFileToSDCard(config, connection, file, file) != 0) {
-            message("107-Failed to write SD card file '%s'", file);
+            nmessage(ERROR_FAILED_TO_WRITE_TO_SD_CARD, file);
             return 1;
         }
     }
@@ -524,32 +521,32 @@ int main(int argc, char *argv[])
     else if (file) {
         loader.setConnection(connection);
         if (file && (sts = loader.fastLoadImage(image, imageSize, (LoadType)loadType)) != 0) {
-            message("102-Download failed: %d", sts);
+            nmessage(ERROR_DOWNLOAD_FAILED, sts);
             return 1;
         }
-        message("005-Download successful!");
+        nmessage(INFO_DOWNLOAD_SUCCESSFUL);
     }
 
     /* set the baud rate used by the program */
     if (connection->setBaudRate(connection->programBaudRate()) != 0) {
-        message("119-Failed to set baud rate");
+        nmessage(ERROR_FAILED_TO_SET_BAUD_RATE);
         return 1;
     }
 
     /* enter terminal mode */
     if (terminalMode) {
-        message("006-[ Entering terminal mode. Type ESC or Control-C to exit. ]");
+        nmessage(INFO_TERMINAL_MODE);
 
         /* open a connection to the target */
         if (!connection->isOpen() && connection->connect() != 0) {
             message("Can't open connection to target");
-            message("105-Failed to enter terminal mode");
+            nmessage(ERROR_FAILED_TO_ENTER_TERMINAL_MODE);
             return 1;
         }
 
         /* enter terminal mode */
         if (connection->terminal(false, pstTerminalMode) != 0) {
-            message("105-Failed to enter terminal mode");
+            nmessage(ERROR_FAILED_TO_ENTER_TERMINAL_MODE);
             return 1;
         }
     }
@@ -592,9 +589,9 @@ static int WriteFileToSDCard(BoardConfig *config, PropConnection *connection, co
     FILE *fp;
 
     /* open the file */
-    message("001-Opening file '%s'", path);
+    nmessage(INFO_OPENING_FILE, path);
     if ((fp = fopen(path, "rb")) == NULL)
-        return error("103-Can't open file '%s'", path);
+        return nerror(ERROR_CANT_OPEN_FILE, path);
 
     if (!target) {
         if (!(target = strrchr(path, '/')))
@@ -623,14 +620,14 @@ static int WriteFileToSDCard(BoardConfig *config, PropConnection *connection, co
     }
 
     while ((cnt = fread(buf, 1, PKTMAXLEN, fp)) > 0) {
-        progress("008-%ld bytes remaining             ", (long)remaining);
+        nprogress(INFO_BYTES_REMAINING, (long)remaining);
         if (!packetDriver.sendPacket(TYPE_DATA, buf, cnt)) {
             fclose(fp);
             return error("SendPacket DATA failed");
         }
         remaining -= cnt;
     }
-    message("009-%ld bytes sent             ", (long)size);
+    nmessage(INFO_BYTES_SENT, (long)size);
 
     fclose(fp);
 

src/messages.cpp

@@ -121,11 +121,11 @@ void nmessage(int code, ...)
     va_end(ap);
 }
 
-void progress(const char *fmt, ...)
+void nprogress(int code, ...)
 {
     va_list ap;
-    va_start(ap, fmt);
-    vmessage(fmt, ap, '\r');
+    va_start(ap, code);
+    vnmessage(code, messageText(code), ap, '\n');
     va_end(ap);
 }
 

src/messages.h

@@ -32,42 +32,44 @@ is created, it simply takes on the next available code number even if it's logic
 */
 
 enum {
-    MIN_INFO                            = 1,
-    INFO_OPENING_FILE                   = MIN_INFO,
-    INFO_DOWNLOADING,
-    INFO_VERIFYING_RAM,
-    INFO_PROGRAMMING_EEPROM,
-    INFO_DOWNLOAD_SUCCESSFUL,
-    INFO_TERMINAL_MODE,
-    INFO_WRITING_TO_SD_CARD,
-    INFO_BYTES_REMAINING,
-    INFO_BYTES_SENT,
-    INFO_SETTING_MODULE_NAME,
+    /* 000 */ DEBUG_MESSAGE,
+
+    MIN_INFO                                        = 1,
+    /* 001 */ INFO_OPENING_FILE                     = MIN_INFO,
+    /* 002 */ INFO_DOWNLOADING,
+    /* 003 */ INFO_VERIFYING_RAM,
+    /* 004 */ INFO_PROGRAMMING_EEPROM,
+    /* 005 */ INFO_DOWNLOAD_SUCCESSFUL,
+    /* 006 */ INFO_TERMINAL_MODE,
+    /* 007 */ INFO_WRITING_TO_SD_CARD,
+    /* 008 */ INFO_BYTES_REMAINING,
+    /* 009 */ INFO_BYTES_SENT,
+    /* 010 */ INFO_SETTING_MODULE_NAME,
     MAX_INFO,
 
-    MIN_ERROR                           = 100,
-    ERROR_CAN_ONLY_NAME_WIFI_MODULES    = MIN_ERROR,
-    ERROR_INVALID_MODULE_ADDRESS,
-    ERROR_DOWNLOAD_FAILED,
-    ERROR_CANT_OPEN_FILE,
-    ERROR_PROPELLER_NOT_FOUND,
-    ERROR_FAILED_TO_ENTER_TERMINAL_MODE,
-    ERROR_WRONG_WIFI_MODULE_FIRMWARE,
-    ERROR_FAILED_TO_WRITE_TO_SD_CARD,
-    ERROR_INVALID_MODULE_NAME,
-    ERROR_FAILED_TO_SET_MODULE_NAME,
-    ERROR_FILE_TRUNCATED,
-    ERROR_FILE_CORRUPTED,
-    ERROR_CANT_READ_PROPELLER_APP_FILE,
-    ERROR_WIFI_MODULE_DISCOVERY_FAILED,
-    ERROR_NO_WIFI_MODULES_FOUND,
-    ERROR_SERIAL_PORT_DISCOVERY_FAILED,
-    ERROR_NO_SERIAL_PORTS_FOUND,
-    ERROR_UNABLE_TO_CONNECT_TO_PORT,
-    ERROR_UNABLE_TO_CONNECT_TO_MODULE,
-    ERROR_FAILED_TO_SET_BAUD_RATE,
-    ERROR_INTERNAL_CODE_ERROR,
-    ERROR_INSUFFICIENT_MEMORY,
+    MIN_ERROR                                       = 100,
+    /* 100 */ ERROR_CAN_ONLY_NAME_WIFI_MODULES      = MIN_ERROR,
+    /* 101 */ ERROR_INVALID_MODULE_ADDRESS,
+    /* 102 */ ERROR_DOWNLOAD_FAILED,
+    /* 103 */ ERROR_CANT_OPEN_FILE,
+    /* 104 */ ERROR_PROPELLER_NOT_FOUND,
+    /* 105 */ ERROR_FAILED_TO_ENTER_TERMINAL_MODE,
+    /* 106 */ ERROR_WRONG_WIFI_MODULE_FIRMWARE,
+    /* 107 */ ERROR_FAILED_TO_WRITE_TO_SD_CARD,
+    /* 108 */ ERROR_INVALID_MODULE_NAME,
+    /* 109 */ ERROR_FAILED_TO_SET_MODULE_NAME,
+    /* 110 */ ERROR_FILE_TRUNCATED,
+    /* 111 */ ERROR_FILE_CORRUPTED,
+    /* 112 */ ERROR_CANT_READ_PROPELLER_APP_FILE,
+    /* 113 */ ERROR_WIFI_MODULE_DISCOVERY_FAILED,
+    /* 114 */ ERROR_NO_WIFI_MODULES_FOUND,
+    /* 115 */ ERROR_SERIAL_PORT_DISCOVERY_FAILED,
+    /* 116 */ ERROR_NO_SERIAL_PORTS_FOUND,
+    /* 117 */ ERROR_UNABLE_TO_CONNECT_TO_PORT,
+    /* 118 */ ERROR_UNABLE_TO_CONNECT_TO_MODULE,
+    /* 119 */ ERROR_FAILED_TO_SET_BAUD_RATE,
+    /* 120 */ ERROR_INTERNAL_CODE_ERROR,
+    /* 121 */ ERROR_INSUFFICIENT_MEMORY,
     MAX_ERROR
 };
 
@@ -78,7 +80,7 @@ int error(const char *fmt, ...);
 int nerror(int code, ...);
 void message(const char *fmt, ...);
 void nmessage(int code, ...);
-void progress(const char *fmt, ...);
+void nprogress(int code, ...);
 
 #ifdef __cplusplus
 }

src/wifipropconnection.cpp

@@ -382,7 +382,7 @@ GET /wx/setting?name=version HTTP/1.1\r\n\
     }
 
     if (!(dst = (char *)malloc(srcLen - 4 + 1))) {
-        message("999-Insufficient memory");
+        nmessage(ERROR_INSUFFICIENT_MEMORY);
         return -1;
     }