bump version 2.1.13; reuse and extract various text fields, take care of backslash in text w.r.t. to python dict

* README.md: structure and sort references
* bump v2.1.8

.github/workflows/pypi-deploy.yml

@@ -10,16 +10,18 @@ jobs:
 
   build_setup:
     name: Prepare environment for wheel builds
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v2
       - name: Prepare wheel build
         run: make -C python/ setup
       - name: Store wheel configuration files
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.6.0
         with:
           name: wheel-config
           path: python/
+      - name: Display files
+        run: ls -lR
 
   build_wheels:
     name: Build binary wheels on ${{ matrix.os }}
@@ -27,7 +29,7 @@ jobs:
     needs: [build_setup]
     strategy:
       matrix:
-        os: [ubuntu-20.04, windows-2019]
+        os: [ubuntu-24.04, windows-2022]
         arch: [auto32, auto64, aarch64]
 
     steps:
@@ -36,7 +38,7 @@ jobs:
       - name: Install cibuildwheel
         run: python -m pip install cibuildwheel==2.1.2
       - name: Get wheel configuration files
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.1.7
         with:
           name: wheel-config
           path: python/
@@ -46,21 +48,21 @@ jobs:
         # env:
         #   CIBW_BUILD: cp36-* cp37-* cp38-* cp39-* cp310-*
       - name: Store binary wheels
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.6.0
         with:
-          name: binary-wheels
+          name: binary-wheels-${{matrix.os}}-${{matrix.arch}}
           path: python/wheelhouse/*.whl
 
   build_sdist:
     name: Build source distribution
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     needs: [build_setup]
     steps:
       - uses: actions/checkout@v2
       - name: Install cython
         run: python -m pip install cython==0.29.24
       - name: Get wheel configuration files
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.1.7
         with:
           name: wheel-config
           path: python/
@@ -68,28 +70,33 @@ jobs:
         run: python setup.py sdist
         working-directory: python/
       - name: Store source wheels
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.6.0
         with:
           name: source-wheels
           path: python/dist/*.tar.gz
+      - name: Display files
+        run: ls -lR
 
 
   upload_pypi:
-    name: Upload binary wheels to PyPI
-    runs-on: ubuntu-20.04
+    name: Upload wheels to PyPI
+    runs-on: ubuntu-24.04
     needs: [build_wheels, build_sdist]
 
     steps:
       - name: Get source wheels
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.1.7
         with:
           name: source-wheels
           path: dist/
       - name: Get binary wheels
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.1.7
         with:
-          name: binary-wheels
           path: dist/
+          pattern: binary-wheels-*
+          merge-multiple: true
+      - name: Display files
+        run: ls -lR
 
       - uses: pypa/gh-action-pypi-publish@release/v1
         with:

README.md

@@ -222,18 +222,31 @@ can be found in the `python/examples` folder.
 
 ## References
 
+### IMC
+
 - https://www.imc-tm.de/produkte/messtechnik-software/imc-famos/funktionen/im-und-export/
 - https://www.imc-tm.de/produkte/messtechnik-hardware/imc-cronosflex/ueberblick/
 - https://www.imc-tm.de/download-center/produkt-downloads/imc-famos/handbuecher
 - https://www.imc-tm.de/fileadmin/Public/Downloads/Manuals/imc_FAMOS/imcGemeinsameKomponenten.pdf
-- https://cython.readthedocs.io/en/latest/src/userguide/wrapping_CPlusPlus.html
 - https://github.com/Apollo3zehn/ImcFamosFile
 - https://apollo3zehn.github.io/ImcFamosFile/api/ImcFamosFile.FamosFileKeyType.html
+
+### Cython
+
+- https://cython.readthedocs.io/en/latest/src/userguide/wrapping_CPlusPlus.html
+
+### PyPI
+
 - https://pypi.org/help/#apitoken
 - https://sgoel.dev/posts/uploading-binary-wheels-to-pypi-from-github-actions/
 - https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 - https://github.com/pypa/cibuildwheel/blob/main/examples/github-deploy.yml
 - https://cibuildwheel.readthedocs.io/en/stable/deliver-to-pypi/
+- https://github.com/actions/download-artifact#download-all-artifacts
+- https://github.com/actions/download-artifact?tab=readme-ov-file#download-multiple-filtered-artifacts-to-the-same-directory
+
+### iconv
+
 - https://www.gnu.org/software/libiconv/
 - https://vcpkg.io/en/packages.html
 - https://vcpkg.io/en/getting-started

lib/imc_channel.hpp

@@ -314,10 +314,11 @@ namespace imc
     std::vector<unsigned char>* buffer_;
 
     imc::origin_data NO_;
-
+    imc::language NL_;
     imc::text CT_;
     imc::groupobj CB_;
     imc::datafield CG_;
+    imc::channelobj CN_;
 
     // collect meta-data of channels according to env,
     // just everything valueable in here
@@ -349,7 +350,7 @@ namespace imc
     double xoffset_, yoffset_;
 
     // group reference the channel belongs to
-    int group_index_;
+    unsigned long int group_index_;
     std::string group_uuid_, group_name_, group_comment_;
 
     // constructor takes channel's block environment
@@ -362,6 +363,22 @@ namespace imc
       // use uuid from CN block
       uuid_ = chnenv_.CNuuid_;
 
+      // extract associated NO data
+      if ( blocks_->count(chnenv_.NOuuid_) == 1 )
+      {
+	NO_.parse(buffer_, blocks_->at(chnenv_.NOuuid_).get_parameters());
+	origin_ = NO_.generator_;
+	comment_ = NO_.comment_;
+      }
+
+      // extract associated NL data
+      if ( blocks_->count(chnenv_.NLuuid_) == 1 )
+      {
+	NL_.parse(buffer_, blocks_->at(chnenv_.NLuuid_).get_parameters());
+	codepage_ = NL_.codepage_;
+	language_code_ = NL_.language_code_;
+      }
+
       // extract associated CB data
       if ( blocks_->count(chnenv_.CBuuid_) == 1 )
       {
@@ -377,6 +394,15 @@ namespace imc
               + CT_.comment_;
       }
 
+      // extract associated CN data
+      if ( blocks_->count(chnenv_.CNuuid_) == 1 )
+      {
+        CN_.parse(buffer_, blocks_->at(chnenv_.CNuuid_).get_parameters());
+	group_index_ = CN_.group_index_;
+	group_name_ = CN_.name_;
+	group_comment_ = CN_.comment_;
+      }
+
       if ( !chnenv_.compenv1_.uuid_.empty() && chnenv_.compenv2_.uuid_.empty() )
       {
         // normal dataset (single component)
@@ -393,7 +419,6 @@ namespace imc
         ybuffer_offset_ = comp_group1.Cb_.offset_buffer_;
         ybuffer_size_ = comp_group1.Cb_.number_bytes_;
         xstart_ = comp_group1.Cb_.x0_;
-        addtime_ = static_cast<long int>(comp_group1.Cb_.add_time_);
         yfactor_ = comp_group1.CR_.factor_;
         yoffset_ = comp_group1.CR_.offset_;
         yunit_ = comp_group1.CR_.unit_;
@@ -407,6 +432,10 @@ namespace imc
         std::time_t ts = timegm(&comp_group1.NT_.tms_); // std::mktime(&tms);
         trigger_time_ = std::chrono::system_clock::from_time_t(ts);
         trigger_time_frac_secs_ = comp_group1.NT_.trigger_time_frac_secs_;
+        // calculate absolute trigger-time
+        addtime_ = static_cast<long int>(comp_group1.Cb_.add_time_);
+        absolute_trigger_time_ = trigger_time_ + std::chrono::seconds(addtime_);
+        //                                       + std::chrono::nanoseconds((long int)(trigger_time_frac_secs_*1.e9));
       }
       else if ( !chnenv_.compenv1_.uuid_.empty() && !chnenv_.compenv2_.uuid_.empty() )
       {
@@ -438,6 +467,7 @@ namespace imc
         std::time_t ts = timegm(&comp_group2.NT_.tms_); // std::mktime(&tms);
         trigger_time_ = std::chrono::system_clock::from_time_t(ts);
         trigger_time_frac_secs_ = comp_group2.NT_.trigger_time_frac_secs_;
+        absolute_trigger_time_ = trigger_time_;
       }
       else
       {
@@ -447,12 +477,9 @@ namespace imc
       // start converting binary buffer to imc::datatype
       if ( !chnenv_.CSuuid_.empty() ) convert_buffer();
 
-      // calculate absolute trigger-time
-      absolute_trigger_time_ = trigger_time_ + std::chrono::seconds(addtime_);
-      //                                       + std::chrono::nanoseconds((long int)(trigger_time_frac_secs_*1.e9));
-
-      // convert any non-UTF-8 codepage to UTF-8
+      // convert any non-UTF-8 codepage to UTF-8 and cleanse any text
       convert_encoding();
+      cleanse_text();
     }
 
     // convert buffer to actual datatype
@@ -508,6 +535,8 @@ namespace imc
           throw std::runtime_error("x and y data have different number of values");
         }
 
+        xprec_ = 9;
+
         process_data(xdata_, xnum_values, xdatatp_, xCSbuffer);
         process_data(ydata_, ynum_values, ydatatp_, yCSbuffer);
       }
@@ -600,6 +629,35 @@ namespace imc
       }
     }
 
+    void cleanse_text()
+    {
+      escape_backslash(name_);
+      escape_backslash(comment_);
+      escape_backslash(origin_);
+      escape_backslash(origin_comment_);
+      escape_backslash(text_);
+      escape_backslash(language_code_);
+      escape_backslash(yname_);
+      escape_backslash(yunit_);
+      escape_backslash(xname_);
+      escape_backslash(xunit_);
+      escape_backslash(group_name_);
+      escape_backslash(group_comment_);
+    }
+
+    void escape_backslash(std::string &text)
+    {
+      char backslash = 0x5c;
+      std::string doublebackslash("\\\\");
+      for ( std::string::iterator it = text.begin(); it != text.end(); ++it )
+      {
+	if ( int(*it) == backslash ) {
+	  text.replace(it,it+1,doublebackslash);
+	  ++it;
+	}
+      }
+    }
+
     // get info string
     std::string get_info(int width = 20)
     {
@@ -624,7 +682,6 @@ namespace imc
         <<std::setw(width)<<std::left<<"significant bits:"<<ysignbits_<<"\n"
         <<std::setw(width)<<std::left<<"buffer-offset:"<<ybuffer_offset_<<"\n"
         <<std::setw(width)<<std::left<<"buffer-size:"<<ybuffer_size_<<"\n"
-        <<std::setw(width)<<std::left<<"add-time:"<<addtime_<<"\n"
         <<std::setw(width)<<std::left<<"xname:"<<xname_<<"\n"
         <<std::setw(width)<<std::left<<"xunit:"<<xunit_<<"\n"
         <<std::setw(width)<<std::left<<"xstepwidth:"<<xstepwidth_<<"\n"
@@ -660,7 +717,6 @@ namespace imc
              <<"\",\"yname\":\""<<prepjsonstr(yname_)
              <<"\",\"yunit\":\""<<prepjsonstr(yunit_)
              <<"\",\"significantbits\":\""<<ysignbits_
-             <<"\",\"addtime\":\""<<addtime_
              <<"\",\"buffer-size\":\""<<ybuffer_size_
              <<"\",\"xname\":\""<<prepjsonstr(xname_)
              <<"\",\"xunit\":\""<<prepjsonstr(xunit_)

lib/imc_object.hpp

@@ -482,7 +482,7 @@ namespace imc
     // construct members by parsing particular parameters from buffer
     void parse(const std::vector<unsigned char>* buffer, const std::vector<parameter>& parameters)
     {
-      if ( parameters.size() < 7 ) throw std::runtime_error("invalid number of parameters in CD2");
+      if ( parameters.size() < 7 ) throw std::runtime_error("invalid number of parameters in NO");
       origin_ = ( get_parameter(buffer,&parameters[2]) == std::string("1") );
       generator_ = get_parameter(buffer,&parameters[4]);
       comment_ = get_parameter(buffer,&parameters[6]);
@@ -508,7 +508,7 @@ namespace imc
     // construct members by parsing particular parameters from buffer
     void parse(const std::vector<unsigned char>* buffer, const std::vector<parameter>& parameters)
     {
-      if ( parameters.size() < 8 ) throw std::runtime_error("invalid number of parameters in CD2");
+      if ( parameters.size() < 8 ) throw std::runtime_error("invalid number of parameters in NT1");
       tms_ = std::tm();
       tms_.tm_mday = std::stoi( get_parameter(buffer,&parameters[2]) );
       tms_.tm_mon = std::stoi( get_parameter(buffer,&parameters[3]) ) - 1;

python/VERSION

@@ -1 +1 @@
-2.1.0
+2.1.13

samples/exampleA-20230124.raw

@@ -0,0 +1,14 @@
+|CF,2,1,1;|CK,1,3,1,1;
+|Nv,1,12,7,3,4,64,1,0;
+|NO,1,12,1,5,FAMOS,0,;
+|NL,1,10,1252,0x407;
+|CG,1,5,1,1,1;
+|CD,1,13,1,1,1,s,0,0,0;
+|NT,1,19, 6, 4,2018,11,33,54;
+|CC,1,3,1,1;
+|CP,1,16,1,8,8,64,0,0,1,0;
+|Cb,1,22,1,0,1,1,0,8,0,8,1,0,0,;
+|CR,1,11,0,0,0,1,1,V;
+|CN,1,35,0,0,0,7,Average,16,Measurement 0815;
+|CT,1,43,0,8,TxTester,8,E. Smith,16,Measurement 0815;
+|CS,1,10,1,ÍÌÌÌÌÌ(@;

samples/exampleB-20230124.raw

@@ -0,0 +1,24 @@
+|CF,2,1,1;|CK,1,3,1,1;
+|Nv,1,12,7,3,4,64,1,0;
+|NO,1,12,1,5,FAMOS,0,;
+|NL,1,10,1252,0x407;
+|CB,1,12,1,5,Meas1,0,;
+|CG,1,5,1,1,1;
+|CD,1,16,5E-1,1,1,2,0,0,0;
+|NT,1,19, 6, 4,2018,11,24,18;
+|CC,1,3,1,1;
+|CP,1,15,1,1,2,8,0,0,1,0;
+|Cb,1,22,1,0,1,1,0,3,0,3,1,3,0,;
+|CR,1,30,1,3.937007874015748E-2,5,1,1,V;
+|ND,1,15,-1,-1,-1,0,1E+1;
+|CN,1,16,1,0,0,5,Chan1,0,;
+|CG,1,5,1,1,1;
+|CD,1,16,5E-1,1,1,2,0,0,0;
+|NT,1,19, 6, 4,2018,11,24,18;
+|CC,1,3,1,1;
+|CP,1,15,2,1,2,8,0,0,1,0;
+|Cb,1,22,1,0,2,1,3,3,0,3,1,3,0,;
+|CR,1,30,1,3.937007874015748E-2,5,1,1,V;
+|ND,1,15,-1,-1,-1,0,1E+1;
+|CN,1,16,1,0,0,5,Chan2,0,;
+|CS,1,8,1, šš šš;

samples/exampleC-20230124.raw

@@ -0,0 +1,17 @@
+|CF,2,1,1;|CK,1,3,1,1;
+|Nv,1,12,7,3,4,64,1,0;
+|NO,1,12,1,5,FAMOS,0,;
+|NL,1,10,1252,0x407;
+|CG,1,5,2,2,2;
+|CD,1,12,1,1,0,,2,0,0;
+|NT,1,18, 6, 4,2018,11,37,1;
+|CC,1,3,1,1;
+|CP,1,16,1,4,7,32,0,0,1,0;
+|Cb,1,24,1,0,1,1,0,16,0,16,1,0,0,;
+|CR,1,11,0,0,0,1,1,V;
+|CN,1,20,0,0,0,9,MyXY_plot,0,;
+|CC,1,3,2,1;
+|CP,1,16,2,2,3,16,0,0,1,0;
+|Cb,1,23,1,0,2,1,16,8,0,8,1,0,0,;
+|CR,1,30,1,4.577706569008927E-5,0,1,1,s;
+|CS,1,26,1, @ €? @ffF@ UUªªÿÿ;