Remove Line Number handling code (most code will be run out of Storage now, where we know the line number)

Debugger now uses jslPrintPosition to print file+line+col

Author: gfwilliams

ChangeLog

@@ -11,6 +11,8 @@
             Increase chars shown in strings in console to 60
             The first Uncaught error is now saved to a file in Storage called ERROR (`E.setFlags({noErrorSave:true})` disables this) (#2583)
             If debugging via bluetooth and we disconnect, quit debugging (locks Bluetooth otherwise)
+            Remove Line Number handling code (most code will be run out of Storage now, where we know the line number)
+            Debugger now uses jslPrintPosition to print file+line+col
 
      2v26 : nRF5x: ensure TIMER1_IRQHandler doesn't always wake idle loop up (fix #1900)
             Puck.js: On v2.1 ensure Puck.mag behaves like other variants - just returning the last reading (avoids glitches when used with Puck.magOn)

README_BuildProcess.md

@@ -180,7 +180,6 @@ These are set automatically when `SAVE_ON_FLASH` is set (see `jsutils.h`)
 * `ESPR_NO_GET_SET` - No Getter/setter functionality
 * `ESPR_NO_OBJECT_METHODS` - No methods in objects like `{method() { ... }}`
 * `ESPR_NO_PROPERTY_SHORTHAND` - No property shorthand in objects like `{a}`
-* `ESPR_NO_LINE_NUMBERS` - disable storing and reporting of Line Numbers. Usually these take 1 var per function, but if we're executing a function from flash we can just work it out from the file when needed
 * `ESPR_NO_LET_SCOPING` - don't create scopes for `let` (treat it like `var`, which was the 2v13 and earlier behaviour)
 * `ESPR_NO_PROMISES` - Don't include promise-handling functions
 * `ESPR_NO_PRETOKENISE` - Don't include code to pretokenise functions marked with `"ram"` - code pretokenised in the IDE can still be executed

boards/BANGLEJS.py

@@ -50,12 +50,11 @@
      'DEFINES+=-DESPR_UNICODE_SUPPORT=1',
      'DEFINES+=-DESPR_NO_SOFTWARE_SERIAL=1',
      'DEFINES+=-DDUMP_IGNORE_VARIABLES=\'"g\\0"\'',
-     'DEFINES+=-DSAVE_ON_FLASH_MATH', 
+     'DEFINES+=-DSAVE_ON_FLASH_MATH',
      'DEFINES+=-DESPR_PACKED_SYMPTR', # Pack builtin symbols' offset into pointer to save 2 bytes/symbol
      'DEFINES+=-DESPR_GRAPHICS_INTERNAL=1',
      'DEFINES+=-DUSE_FONT_6X8 -DGRAPHICS_PALETTED_IMAGES -DGRAPHICS_ANTIALIAS -DESPR_PBF_FONTS',
      'DEFINES+=-DNO_DUMP_HARDWARE_INITIALISATION', # don't dump hardware init - not used and saves 1k of flash
-     'DEFINES+=-DESPR_NO_LINE_NUMBERS=1', # we execute mainly from flash, so line numbers can be worked out
      'DEFINES+=-DAPP_TIMER_OP_QUEUE_SIZE=6', # Bangle.js accelerometer poll handler needs something else in queue size
      'DFU_PRIVATE_KEY=targets/nrf5x_dfu/dfu_private_key.pem',
      'DFU_SETTINGS=--application-version 0xff --hw-version 52 --sd-req 0x8C,0x91',

boards/BANGLEJS2.py

@@ -50,7 +50,7 @@
      #'DEFINES += -DESPR_REGOUT0_1_8V=1', # this increases power draw, so probably not correct!
      'DEFINES += -DESPR_LSE_ENABLE', # Ensure low speed external osc enabled
      'DEFINES += -DNRF_SDH_BLE_GATT_MAX_MTU_SIZE=131', # 23+x*27 rule as per https://devzone.nordicsemi.com/f/nordic-q-a/44825/ios-mtu-size-why-only-185-bytes
-     'DEFINES += -DNRF_SDH_BLE_GAP_EVENT_LENGTH=6', # Needed to allow coded phy connections 
+     'DEFINES += -DNRF_SDH_BLE_GAP_EVENT_LENGTH=6', # Needed to allow coded phy connections
      'DEFINES += -DCENTRAL_LINK_COUNT=2 -DNRF_SDH_BLE_CENTRAL_LINK_COUNT=2', # allow two outgoing connections at once
      'LDFLAGS += -Xlinker --defsym=LD_APP_RAM_BASE=0x3b70', # set RAM base to match MTU=131 + CENTRAL_LINK_COUNT=2 + GAP_EVENT_LENGTH=6
      'DEFINES += -DESPR_DCDC_ENABLE=1', # Use DC/DC converter
@@ -67,7 +67,6 @@
      'DEFINES+=-DESPR_BATTERY_FULL_VOLTAGE=0.3144',
      'DEFINES+=-DUSE_FONT_6X8 -DGRAPHICS_PALETTED_IMAGES -DGRAPHICS_ANTIALIAS -DESPR_PBF_FONTS',
      'DEFINES+=-DNO_DUMP_HARDWARE_INITIALISATION', # don't dump hardware init - not used and saves 1k of flash
-     'DEFINES += -DESPR_NO_LINE_NUMBERS=1', # we execute mainly from flash, so line numbers can be worked out
      'INCLUDE += -I$(ROOT)/libs/banglejs -I$(ROOT)/libs/misc',
      'WRAPPERSOURCES += libs/banglejs/jswrap_bangle.c',
      'WRAPPERSOURCES += libs/graphics/jswrap_font_14.c',

boards/BANGLEJS2_IFLASH.py

@@ -58,7 +58,7 @@
      #'DEFINES += -DESPR_REGOUT0_1_8V=1', # this increases power draw, so probably not correct!
      'DEFINES += -DESPR_LSE_ENABLE', # Ensure low speed external osc enabled
      'DEFINES += -DNRF_SDH_BLE_GATT_MAX_MTU_SIZE=131', # 23+x*27 rule as per https://devzone.nordicsemi.com/f/nordic-q-a/44825/ios-mtu-size-why-only-185-bytes
-     'DEFINES += -DNRF_SDH_BLE_GAP_EVENT_LENGTH=6', # Needed to allow coded phy connections 
+     'DEFINES += -DNRF_SDH_BLE_GAP_EVENT_LENGTH=6', # Needed to allow coded phy connections
      'DEFINES += -DCENTRAL_LINK_COUNT=2 -DNRF_SDH_BLE_CENTRAL_LINK_COUNT=2', # allow two outgoing connections at once
      'LDFLAGS += -Xlinker --defsym=LD_APP_RAM_BASE=0x3b70', # set RAM base to match MTU=131 + CENTRAL_LINK_COUNT=2 + GAP_EVENT_LENGTH=6
      'DEFINES += -DESPR_DCDC_ENABLE=1', # Use DC/DC converter
@@ -75,7 +75,6 @@
      'DEFINES+=-DESPR_BATTERY_FULL_VOLTAGE=0.3144',
      'DEFINES+=-DUSE_FONT_6X8 -DGRAPHICS_PALETTED_IMAGES -DGRAPHICS_ANTIALIAS -DESPR_PBF_FONTS',
      'DEFINES+=-DNO_DUMP_HARDWARE_INITIALISATION', # don't dump hardware init - not used and saves 1k of flash
-     'DEFINES += -DESPR_NO_LINE_NUMBERS=1', # we execute mainly from flash, so line numbers can be worked out
      'INCLUDE += -I$(ROOT)/libs/banglejs -I$(ROOT)/libs/misc',
      'WRAPPERSOURCES += libs/banglejs/jswrap_bangle.c',
      'WRAPPERSOURCES += libs/graphics/jswrap_font_14.c',

boards/BANGLEJS2_LINUX.py

@@ -34,7 +34,7 @@
      'GRAPHICS',
      'FILESYSTEM', # for writing screenshots/etc
      'LCD_MEMLCD',
-#     'TENSORFLOW'  
+#     'TENSORFLOW'
    ],
    'makefile' : [
      'LINUX=1',
@@ -44,7 +44,6 @@
      'DEFINES+=-DESPR_GRAPHICS_INTERNAL=1',
      'DEFINES += -DUSE_FONT_6X8 -DGRAPHICS_PALETTED_IMAGES -DESPR_GRAPHICS_3BIT',
      'DEFINES += -DNO_DUMP_HARDWARE_INITIALISATION', # don't dump hardware init - not used and saves 1k of flash
-     'DEFINES += -DESPR_NO_LINE_NUMBERS=1', # we execute mainly from flash, so line numbers can be worked out
      'INCLUDE += -I$(ROOT)/libs/banglejs -I$(ROOT)/libs/misc',
      'WRAPPERSOURCES += libs/banglejs/jswrap_bangle.c',
      'WRAPPERSOURCES += libs/graphics/jswrap_font_6x15.c',
@@ -80,7 +79,7 @@
   'BTN1' : { 'pin' : 'D17', 'pinstate' : 'IN_PULLDOWN' }, # Pin negated in software
   'LED1' : { 'pin' : 'D8', 'novariable':True }, # Backlight flash for low level debug - but in code we just use 'fake' LEDs
   'LCD' : {
-            'width' : 176, 'height' : 176, 
+            'width' : 176, 'height' : 176,
             'bpp' : 3,
             'controller' : 'LPM013M126', # LPM013M126C
             'pin_cs' : 'D5',

boards/BANGLEJS2_NOFLASH.py

@@ -65,7 +65,6 @@
      'DEFINES+=-DESPR_BATTERY_FULL_VOLTAGE=0.3144',
      'DEFINES+=-DUSE_FONT_6X8 -DGRAPHICS_PALETTED_IMAGES -DGRAPHICS_ANTIALIAS -DESPR_PBF_FONTS',
      'DEFINES+=-DNO_DUMP_HARDWARE_INITIALISATION', # don't dump hardware init - not used and saves 1k of flash
-     'DEFINES += -DESPR_NO_LINE_NUMBERS=1', # we execute mainly from flash, so line numbers can be worked out
      'INCLUDE += -I$(ROOT)/libs/banglejs -I$(ROOT)/libs/misc',
      'WRAPPERSOURCES += libs/banglejs/jswrap_bangle.c',
      'WRAPPERSOURCES += libs/graphics/jswrap_font_6x15.c',

boards/EMSCRIPTEN.py

@@ -33,14 +33,13 @@
    ],
    'makefile' : [
      'EMSCRIPTEN=1',
-     'USE_DEBUGGER=0', # We can't use debugger in emulator as we're single-threaded and it uses IRQs on embedded to work     
+     'USE_DEBUGGER=0', # We can't use debugger in emulator as we're single-threaded and it uses IRQs on embedded to work
      'DEFINES += -DESPR_HWVERSION=1',
      'DEFINES += -DUSE_CALLFUNCTION_HACK', # required to handle calls properly
      'DEFINES += -DBANGLEJS -DBANGLEJS_F18 -DEMULATED -DEMSCRIPTEN',
      'DEFINES += -DSPIFLASH_BASE=0x8000000 -DSPIFLASH_LENGTH=4194304',
 #     'DEFINES+=-DCUSTOM_GETBATTERY=jswrap_banglejs_getBattery',
      'DEFINES+=-DDUMP_IGNORE_VARIABLES=\'"g\\0"\'',
-     'DEFINES += -DESPR_NO_LINE_NUMBERS=1', # we execute mainly from flash, so line numbers can be worked out
      'DEFINES+=-DESPR_GRAPHICS_INTERNAL=1',
      'DEFINES+=-DUSE_FONT_6X8 -DGRAPHICS_PALETTED_IMAGES -DGRAPHICS_ANTIALIAS',
      'INCLUDE += -I$(ROOT)/libs/banglejs -I$(ROOT)/libs/misc',

boards/EMSCRIPTEN2.py

@@ -41,7 +41,6 @@
      'DEFINES += -DSPIFLASH_BASE=0x8000000 -DSPIFLASH_LENGTH=8388608',
 #     'DEFINES+=-DCUSTOM_GETBATTERY=jswrap_banglejs_getBattery',
      'DEFINES+=-DDUMP_IGNORE_VARIABLES=\'"g\\0"\'',
-     'DEFINES += -DESPR_NO_LINE_NUMBERS=1', # we execute mainly from flash, so line numbers can be worked out
      'DEFINES+=-DESPR_GRAPHICS_INTERNAL=1',
      'DEFINES+=-DUSE_FONT_6X8 -DGRAPHICS_PALETTED_IMAGES -DGRAPHICS_ANTIALIAS',
      'INCLUDE += -I$(ROOT)/libs/banglejs -I$(ROOT)/libs/misc',
@@ -84,7 +83,7 @@
   'BTN1' : { 'pin' : 'D17', 'pinstate' : 'IN_PULLDOWN' }, # Pin negated in software
   'LED1' : { 'pin' : 'D8', 'novariable':True }, # Backlight flash for low level debug - but in code we just use 'fake' LEDs
   'LCD' : {
-            'width' : 176, 'height' : 176, 
+            'width' : 176, 'height' : 176,
             'bpp' : 3,
             'controller' : 'LPM013M126', # LPM013M126C
             'pin_cs' : 'D5',

boards/MICROBIT1.py

@@ -34,7 +34,6 @@
    'makefile' : [
      'SAVE_ON_FLASH=1',
      'DEFINES+=-DSAVE_ON_FLASH_EXTREME',
-     'DEFINES+=-DESPR_NO_LINE_NUMBERS',
      'DEFINES+=-DESPR_LIMIT_DATE_RANGE',
      'DEFINES+=-DESPR_PACKED_SYMPTR', # Pack builtin symbols' offset into pointer to save 2 bytes/symbol
      'DEFINES+=-DESPR_NO_DAYLIGHT_SAVING',

src/jsflash.c

@@ -1415,7 +1415,7 @@ bool jsfLoadBootCodeFromFlash(bool isReset) {
   if (jsiStatus & JSIS_FIRST_BOOT) {
     JsVar *code = jsfReadFile(jsfNameFromString(".bootPowerOn"),0,0);
     if (code) {
-      jsvUnLock2(jspEvaluateVar(code,0,".bootPowerOn",0), code);
+      jsvUnLock2(jspEvaluateVar(code,0,".bootPowerOn"), code);
       jsiCheckErrors(false);
     }
   }
@@ -1437,15 +1437,15 @@ bool jsfLoadBootCodeFromFlash(bool isReset) {
       filename[5] = (char)('0'+i);
       JsVar *code = jsfReadFile(jsfNameFromString(filename),0,0);
       if (code) {
-        jsvUnLock2(jspEvaluateVar(code,0,filename,0), code);
+        jsvUnLock2(jspEvaluateVar(code,0,filename), code);
         jsiCheckErrors(false);
       }
     }
   }
   // Load normal boot code
   JsVar *code = jsfGetBootCodeFromFlash(isReset);
   if (!code) return false;
-  jsvUnLock2(jspEvaluateVar(code,0,"boot code",0), code);
+  jsvUnLock2(jspEvaluateVar(code,0,"boot code"), code);
   jsiCheckErrors(false);
   return true;
 }

src/jsinteractive.c

@@ -128,7 +128,6 @@ size_t inputCursorPos = 0; ///< The position of the cursor in the input line
 InputState inputState = 0; ///< state for dealing with cursor keys
 uint16_t inputPacketLength; ///< When receiving an input packet, the length of it
 uint16_t inputStateNumber; ///< Number from when `Esc [ 1234` is sent - for storing line number
-uint16_t jsiLineNumberOffset; ///< When we execute code, this is the 'offset' we apply to line numbers in error/debug
 bool hasUsedHistory = false; ///< Used to speed up - if we were cycling through history and then edit, we need to copy the string
 unsigned char loopsIdling = 0; ///< How many times around the loop have we been entirely idle?
 JsErrorFlags lastJsErrorFlags = 0; ///< Compare with jsErrorFlags in order to report errors
@@ -284,8 +283,11 @@ NO_INLINE void jsiConsolePrintString(const char *str) {
   }
 }
 
+/// Used as a callback for using vcbprintf to write to the console. If given *size_t as user_data it incremenets it with the string length
 void vcbprintf_callback_jsiConsolePrintString(const char *str, void* user_data) {
-  NOT_USED(user_data);
+  if (user_data) {
+    *((size_t*)user_data) += strlen(str);
+  }
   jsiConsolePrintString(str);
 }
 
@@ -391,9 +393,9 @@ void jsiMoveCursor(size_t oldX, size_t oldY, size_t newX, size_t newY) {
 void jsiMoveCursorChar(JsVar *v, size_t fromCharacter, size_t toCharacter) {
   if (fromCharacter==toCharacter) return;
   size_t oldX, oldY;
-  jsvGetLineAndCol(v, fromCharacter, &oldY, &oldX);
+  jsvGetLineAndCol(v, fromCharacter, &oldY, &oldX, NULL);
   size_t newX, newY;
-  jsvGetLineAndCol(v, toCharacter, &newY, &newX);
+  jsvGetLineAndCol(v, toCharacter, &newY, &newX, NULL);
   jsiMoveCursor(oldX, oldY, newX, newY);
 }
 
@@ -501,7 +503,6 @@ void jsiSoftInit(bool hasBeenReset) {
   events = jsvNewEmptyArray();
   inputLine = jsvNewFromEmptyString();
   inputCursorPos = 0;
-  jsiLineNumberOffset = 0;
   jsiInputLineCursorMoved();
   inputLineIterator.var = 0;
 
@@ -539,7 +540,7 @@ void jsiSoftInit(bool hasBeenReset) {
   // Now run initialisation code
   JsVar *initCode = jsvObjectGetChildIfExists(execInfo.hiddenRoot, JSI_INIT_CODE_NAME);
   if (initCode) {
-    jsvUnLock2(jspEvaluateVar(initCode, 0, "initcode", 0), initCode);
+    jsvUnLock2(jspEvaluateVar(initCode, 0, "initcode"), initCode);
     jsiCheckErrors(false);
     jsvObjectRemoveChild(execInfo.hiddenRoot, JSI_INIT_CODE_NAME);
   }
@@ -1239,28 +1240,28 @@ void jsiHandleEnd() {
 /** Page up/down move cursor to beginnint or end */
 void jsiHandlePageUpDown(bool isDown) {
   size_t x,y;
-  jsvGetLineAndCol(inputLine, inputCursorPos, &y, &x);
+  jsvGetLineAndCol(inputLine, inputCursorPos, &y, &x, NULL);
   if (!isDown) { // up
     inputCursorPos = 0;
   } else { // down
     inputCursorPos = jsvGetStringLength(inputLine);
   }
   size_t newX=x,newY=y;
-  jsvGetLineAndCol(inputLine, inputCursorPos, &newY, &newX);
+  jsvGetLineAndCol(inputLine, inputCursorPos, &newY, &newX, NULL);
   jsiMoveCursor(x,y,newX,newY);
 }
 
 void jsiHandleMoveUpDown(int direction) {
   size_t x,y, lines=jsvGetLinesInString(inputLine);
-  jsvGetLineAndCol(inputLine, inputCursorPos, &y, &x);
+  jsvGetLineAndCol(inputLine, inputCursorPos, &y, &x, NULL);
   size_t newX=x,newY=y;
   newY = (size_t)((int)newY + direction);
   if (newY<1) newY=1;
   if (newY>lines) newY=lines;
   // work out cursor pos and feed back through - we might not be able to get right to the same place
   // if we move up
   inputCursorPos = jsvGetIndexFromLineAndCol(inputLine, newY, newX);
-  jsvGetLineAndCol(inputLine, inputCursorPos, &newY, &newX);
+  jsvGetLineAndCol(inputLine, inputCursorPos, &newY, &newX, NULL);
   if (jsiShowInputLine()) {
     jsiMoveCursor(x,y,newX,newY);
   }
@@ -1557,14 +1558,13 @@ void jsiHandleNewLine(bool execute) {
 #endif
       {
         // execute!
-        JsVar *v = jspEvaluateVar(lineToExecute, 0, "REPL", jsiLineNumberOffset);
+        JsVar *v = jspEvaluateVar(lineToExecute, 0, "REPL");
         // add input line to history
         bool isEmpty = jsvIsEmptyString(lineToExecute);
         // Don't store history if we're not echoing back to the console (it probably wasn't typed by the user)
         if (!isEmpty && jsiEcho())
           jsiHistoryAddLine(lineToExecute);
         jsvUnLock(lineToExecute);
-        jsiLineNumberOffset = 0; // forget the current line number now
         // print result (but NOT if we had an error)
         if (jsiEcho() && !jspHasError() && !isEmpty) {
           jsiConsolePrintChar('=');
@@ -1948,8 +1948,7 @@ static void jsiHandleConsoleChar(char ch) {
     if (ch>='0' && ch<='9') {
       inputStateNumber = (uint16_t)(10*inputStateNumber + ch - '0');
     } else {
-      if (ch=='d') jsiLineNumberOffset = inputStateNumber;
-      else if (ch=='H' /* 72 */) {
+      if (ch=='H' /* 72 */) {
         if (inputStateNumber==2) jsiClearInputLine(true); // Erase current line
       } else if (ch==126) {
         if (inputStateNumber==1) jsiHandleHome(); // Numpad Home
@@ -2069,7 +2068,7 @@ static NO_INLINE bool jsiExecuteEventCallbackInner(JsVar *thisVar, JsVar *callba
   } else if (jsvIsFunction(callbackNoNames)) {
     jsvUnLock(jspExecuteFunction(callbackNoNames, thisVar, (int)argCount, argPtr));
   } else if (jsvIsString(callbackNoNames)) {
-    jsvUnLock(jspEvaluateVar(callbackNoNames, 0, "event", 0));
+    jsvUnLock(jspEvaluateVar(callbackNoNames, 0, "event"));
   } else
     jsError("Unknown type of callback in Event Queue");
   return ok;
@@ -2594,7 +2593,7 @@ void jsiIdle() {
         // load the code we specified
         JsVar *code = jsfReadFile(filename,0,0);
         if (code) // only supply the filename if we're sure it's zero terminated
-          jsvUnLock2(jspEvaluateVar(code,0,filename.c[sizeof(filename.c)-1] ? filename.c : "load",0), code);
+          jsvUnLock2(jspEvaluateVar(code,0,filename.c[sizeof(filename.c)-1] ? filename.c : "load"), code);
       } else {
         jsiSoftKill();
         jspSoftKill();
@@ -2826,22 +2825,11 @@ void jsiDebuggerLoop() {
   jsiStatus = (jsiStatus & ~JSIS_ECHO_OFF_MASK) | JSIS_IN_DEBUGGER;
 
   if (lex) {
-    char lineStr[9];
-    // Get a string fo the form '1234    ' for the line number
-    // ... but only if the line number was set, otherwise use spaces
-#ifndef ESPR_NO_LINE_NUMBERS
-    if (lex->lineNumberOffset) {
-      itostr((JsVarInt)jslGetLineNumber() + (JsVarInt)lex->lineNumberOffset - 1, lineStr, 10);
-    } else
-#endif
-    { // FIXME: Maybe if executing from a Storage file we use line numbers within that file?
-      lineStr[0]=0;
-    }
-    size_t lineLen = strlen(lineStr);
-    while (lineLen < sizeof(lineStr)-1) lineStr[lineLen++]=' ';
-    lineStr[lineLen] = 0;
-    // print the line of code, prefixed by the line number, and with a pointer to the exact character in question
-    jslPrintTokenLineMarker(vcbprintf_callback_jsiConsolePrintString, 0, lex, lex->tokenLastStart, lineStr);
+    // print the line of code, prefixed by the file/line number, and with a pointer to the exact character in question
+    size_t prefixLength = 0;
+    jslPrintPosition(vcbprintf_callback_jsiConsolePrintString, &prefixLength, lex, lex->tokenLastStart);
+    jsiConsolePrint("   "); prefixLength+=3;
+    jslPrintTokenLineMarker(vcbprintf_callback_jsiConsolePrintString, 0, lex, lex->tokenLastStart, prefixLength);
   }
 
   while (!(jsiStatus & JSIS_EXIT_DEBUGGER) &&