Add optional support for L records (#671)

Co-authored-by: Kai Wissel <kai.wpkt@gmail.com>
Turbo87 · Jan 6, 2025 · 07b47ac · 07b47ac
1 parent 1194b3d
commit 07b47ac
Show file tree

Hide file tree

Showing 3 changed files with 237 additions and 1 deletion.
diff --git a/__snapshots__/test.ts.snap b/__snapshots__/test.ts.snap
@@ -3,6 +3,200 @@
 exports[`IGCParser parse() 1G_77fv6m71.igc 1`] = `
 {
   "callsign": "1G",
+  "commentRecords": [
+    {
+      "code": "LXV",
+      "message": "OZ=-1,Style=2,R1=10000m,A1=180,R2=0m,A2=0,A12=238.1,Line=1,Autonext=0,Lat=5108.483N,Lon=00659.117E",
+    },
+    {
+      "code": "LXV",
+      "message": "OZ=0,Style=1,R1=10000m,A1=180,R2=0m,A2=0,A12=85.7,Autonext=0,AAT=1,Lat=5049.450N,Lon=00611.217E",
+    },
+    {
+      "code": "LXV",
+      "message": "OZ=1,Style=1,R1=30000m,A1=180,R2=0m,A2=0,A12=301.1,Autonext=1,AAT=1,Lat=5033.583N,Lon=00708.250E",
+    },
+    {
+      "code": "LXV",
+      "message": "OZ=2,Style=1,R1=10000m,A1=180,R2=0m,A2=0,A12=93.0,Autonext=0,AAT=1,Lat=5053.333N,Lon=00629.500E",
+    },
+    {
+      "code": "LXV",
+      "message": "OZ=3,Style=1,R1=10000m,A1=180,R2=0m,A2=0,A12=234.7,Autonext=1,AAT=1,Lat=5110.617N,Lon=00712.000E",
+    },
+    {
+      "code": "LXV",
+      "message": "OZ=4,Style=3,R1=2000m,A1=180,R2=0m,A2=0,A12=52.4,Elev=650m,Autonext=0,Lat=5105.867N,Lon=00702.217E",
+    },
+    {
+      "code": "LXV",
+      "message": "TSK,TaskTime=7200s",
+    },
+    {
+      "code": "LXV",
+      "message": "WAKE:5362",
+    },
+    {
+      "code": "LXV",
+      "message": "LXNAV V9:5.14,SN#04711",
+    },
+    {
+      "code": "LXV",
+      "message": "VIND,SN#03164,SW5.07,HW25",
+    },
+    {
+      "code": "LXV",
+      "message": "IASAUTOZERO:0",
+    },
+    {
+      "code": "LXV",
+      "message": "TAKEOFF,TAS,GSP",
+    },
+    {
+      "code": "LXV",
+      "message": "FINISH",
+    },
+    {
+      "code": "LXV",
+      "message": "::TKOFFLAND:1,20170715101855,20170715143911",
+    },
+    {
+      "code": "LXV",
+      "message": "::TKOFFLANDALT:1,45,-16384",
+    },
+    {
+      "code": "LXV",
+      "message": "::TKOFFLANDNAME:1,EDKL,EDKL",
+    },
+    {
+      "code": "LXV",
+      "message": "::TKOFFLANDLOC:1,0.890328,0.122328,0.890356,0.122310",
+    },
+    {
+      "code": "LXV",
+      "message": "::SOARINGBEGIN:1,20170715102348,-16384",
+    },
+    {
+      "code": "LXV",
+      "message": "::OPT:1,3,224560,5,262646,5,262646",
+    },
+    {
+      "code": "LXV",
+      "message": "::TRIANGLE:1,FAI_NO,212336",
+    },
+    {
+      "code": "LXV",
+      "message": "::FLTSTAT1:1,17.86,1.12,38.61,-16384,-16384,-16384.00",
+    },
+    {
+      "code": "LXV",
+      "message": "::FLTSTAT2:1,,",
+    },
+    {
+      "code": "LXV",
+      "message": "::FLTVARIO:1,-16384,-16384.00,,-16384.00,",
+    },
+    {
+      "code": "LXV",
+      "message": "::TASK:1,0,106580,7.89,0.156343",
+    },
+    {
+      "code": "LXV",
+      "message": "::ENGSTAT1:1,1,0",
+    },
+    {
+      "code": "LXV",
+      "message": "::ENDINFO",
+    },
+    {
+      "code": "SCS",
+      "message": "DCID:1G",
+    },
+    {
+      "code": "SCS",
+      "message": "DName:Graf, Florian",
+    },
+    {
+      "code": "SCS",
+      "message": "DGate open:10:49",
+    },
+    {
+      "code": "SCS",
+      "message": "DGate close:12:49",
+    },
+    {
+      "code": "SCS",
+      "message": "DTime window:03:30",
+    },
+    {
+      "code": "SCS",
+      "message": "Dmax Elevation start:0",
+    },
+    {
+      "code": "SCS",
+      "message": "Dmax Elevation:0",
+    },
+    {
+      "code": "SCS",
+      "message": "DQNH:1022",
+    },
+    {
+      "code": "SCS",
+      "message": "DElevation start:47",
+    },
+    {
+      "code": "SCS",
+      "message": "RSLINE:20000",
+    },
+    {
+      "code": "SCS",
+      "message": "RTKEYHOLE:500:10000:90",
+    },
+    {
+      "code": "SCS",
+      "message": "RFCYLINDER:2000",
+    },
+    {
+      "code": "SCS",
+      "message": "CS:006Langenfeld-Wiescheid:N5108483:E00659117",
+    },
+    {
+      "code": "SCS",
+      "message": "CT:009Aachen-Merzbrueck:N5049450:E00611217",
+    },
+    {
+      "code": "SCS",
+      "message": "A0:10000:0:0",
+    },
+    {
+      "code": "SCS",
+      "message": "CT:019Bad Neuenahr:N5033583:E00708250",
+    },
+    {
+      "code": "SCS",
+      "message": "A0:30000:0:0",
+    },
+    {
+      "code": "SCS",
+      "message": "CT:058Hambach S�d:N5053333:E00629500",
+    },
+    {
+      "code": "SCS",
+      "message": "A0:10000:0:0",
+    },
+    {
+      "code": "SCS",
+      "message": "CT:110Remscheid Bhf:N5110617:E00712000",
+    },
+    {
+      "code": "SCS",
+      "message": "A0:10000:0:0",
+    },
+    {
+      "code": "SCS",
+      "message": "CF:002Zielkreis:N5105867:E00702217",
+    },
+  ],
   "competitionClass": "Club",
   "copilot": null,
   "dataRecords": [
@@ -190,6 +384,7 @@ exports[`IGCParser parse() 1G_77fv6m71.igc 1`] = `
 exports[`IGCParser parse() 654G6NG1.IGC 1`] = `
 {
   "callsign": "TH",
+  "commentRecords": [],
   "competitionClass": "Club",
   "copilot": "",
   "dataRecords": [],
@@ -332,6 +527,7 @@ exports[`IGCParser parse() 654G6NG1.IGC 1`] = `
 exports[`IGCParser parse() 2016-11-08-xcs-aaa-02.igc 1`] = `
 {
   "callsign": "",
+  "commentRecords": [],
   "competitionClass": null,
   "copilot": null,
   "dataRecords": [],
@@ -459,6 +655,7 @@ exports[`IGCParser parse() 2016-11-08-xcs-aaa-02.igc 1`] = `
 exports[`IGCParser parse() 20180427.igc 1`] = `
 {
   "callsign": "86",
+  "commentRecords": [],
   "competitionClass": "",
   "copilot": null,
   "dataRecords": [],
@@ -535,6 +732,7 @@ exports[`IGCParser parse() 20180427.igc 1`] = `
 exports[`IGCParser parse() 20211015.igc 1`] = `
 {
   "callsign": "0000",
+  "commentRecords": [],
   "competitionClass": "Paraglider (Standard)",
   "copilot": null,
   "dataRecords": [],
@@ -662,6 +860,10 @@ exports[`IGCParser parseIJRecord() I0136FXA38 -> 💥  1`] = `"Invalid I record
 
 exports[`IGCParser parseIJRecord() I023638FXA -> 💥  1`] = `"Invalid I record at line 0: I023638FXA"`;
 
+exports[`IGCParser parseLRecord() [empty] -> 💥  1`] = `"Invalid L record at line 0: "`;
+
+exports[`IGCParser parseLRecord() LXP code to short -> 💥  1`] = `"Invalid L record at line 0: LXP code to short"`;
+
 exports[`IGCParser parsePilot() [empty] -> 💥  1`] = `"Invalid PLT header at line 0: "`;
 
 exports[`IGCParser parsePilot() HFPLX:John Doe -> 💥  1`] = `"Invalid PLT header at line 0: HFPLX:John Doe"`;

diff --git a/index.ts b/index.ts
@@ -23,6 +23,7 @@ const RE_ALP_HEADER = /^H(\w)ALP(?:.{0,}?:(.*)|(.*))$/;
 const RE_B = /^B(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\d{3})([NS])(\d{3})(\d{2})(\d{3})([EW])([AV])(-\d{4}|\d{5})(-\d{4}|\d{5})/;
 const RE_K = /^K(\d{2})(\d{2})(\d{2})/;
 const RE_IJ = /^[IJ](\d{2})(?:\d{2}\d{2}[A-Z]{3})+/;
+const RE_L = /^[L]([A-Z]{3})(.+)/;
 const RE_TASK = /^C(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\d{4})([-\d]{2})(.*)/;
 const RE_TASKPOINT = /^C(\d{2})(\d{2})(\d{3})([NS])(\d{3})(\d{2})(\d{3})([EW])(.*)/;
 const RE_INT = /^\d*$/;
@@ -33,6 +34,7 @@ const VALID_DATA_SOURCES = ['F', 'O', 'P'];
 declare namespace IGCParser {
   export interface Options {
     lenient?: boolean;
+    parseComments?: boolean;
   }
 
   export interface IGCFile {
@@ -63,6 +65,7 @@ declare namespace IGCParser {
 
     fixes: BRecord[];
     dataRecords: KRecord[];
+    commentRecords: LRecord[];
 
     security: string | null;
 
@@ -72,6 +75,7 @@ declare namespace IGCParser {
   interface PartialIGCFile extends Partial<IGCFile> {
     fixes: BRecord[];
     dataRecords: KRecord[];
+    commentRecords: LRecord[];
   }
 
   export interface ARecord {
@@ -112,6 +116,11 @@ declare namespace IGCParser {
     extensions: RecordExtensions;
   }
 
+  export interface LRecord {
+    code: string;
+    message: string
+  }
+
   export interface RecordExtensions {
     [code: string]: string;
   }
@@ -161,6 +170,7 @@ class IGCParser {
     task: null,
     fixes: [],
     dataRecords: [],
+    commentRecords: [],
     security: null,
     errors: [],
   };
@@ -251,6 +261,9 @@ class IGCParser {
     } else if (recordType === 'J') {
       this.dataExtensions = this.parseIJRecord(line);
 
+    } else if (recordType === 'L' && this.options.parseComments) {
+      this._result.commentRecords.push(this.parseLRecord(line));
+
     } else if (recordType === 'G') {
       this._result.security = (this._result.security || '') + line.slice(1);
     }
@@ -567,6 +580,18 @@ class IGCParser {
     return extensions;
   }
 
+  private parseLRecord(line: string): IGCParser.LRecord {
+    let match = line.match(RE_L);
+    if (!match) {
+      throw new Error(`Invalid L record at line ${this.lineNumber}: ${line}`);
+    }
+
+    return {
+      code: match[1],
+      message: match[2].trim()
+    };
+  }
+
   private static parseLatitude(dd: string, mm: string, mmm: string, ns: string): number {
     let degrees = parseInt(dd, 10) + parseFloat(`${mm}.${mmm}`) / 60;
     return (ns === 'S') ? -degrees : degrees;

diff --git a/test.ts b/test.ts
@@ -13,7 +13,7 @@ describe('IGCParser', () => {
   describe('parse()', () => {
     test('1G_77fv6m71.igc', () => {
       let content = fs.readFileSync(`${__dirname}/fixtures/1G_77fv6m71.igc`, 'utf8');
-      let result = IGCParser.parse(content);
+      let result = IGCParser.parse(content, { parseComments: true });
 
       expect(result.fixes.length).toEqual(4047);
       expect(result.dataRecords.length).toEqual(80);
@@ -434,6 +434,15 @@ describe('IGCParser', () => {
     test.fail('');
   });
 
+  describeMethod('parseLRecord', (test) => {
+    test.pass('LXMP 2 Trackpoints removed by user',
+      { code: 'XMP', message: "2 Trackpoints removed by user" },
+    );
+
+    test.fail('');
+    test.fail('LXP code to short');
+  });
+
   // Test Suite Generator
 
   function describeMethod(methodName: string, cb: (test: any) => void) {