Scan keywords with roffio when importing GridProperties

[mferrera]

Resolves #939

This test failure is caused by

xtgeo/src/clib/xtg/grd3d_scan_roffbinary.c

Lines 367 to 373 in 69d8caa

	/* add a third item if parameter name */
	if (strncmp(cname[j], "name", 4) == 0 &&
	strncmp(pname[j], "NAxxx", 2) != 0) {
	strcat(tagletters, "!");
	strcat(tagletters, pname[j]);
	}

This will ignore any properties starting with "NA", which is probably not what we want. This PR changes to scan keywords with roffio instead, at a minor performance hit. We could probably seek to replace the C scan with roffio completely, but the GridProperties.scan_keywords() method has a return format that roffio cannot support.

Benchmarks:

• xtgeo-testdata/1/geogrid.roff
  • roffio: 0.013
  • cxtgeo: 0.003
• xtgeo-testdata/2/geogrid.roff
  • roffio: 0.013
  • cxtgeo: 0.003
• xtgeo-testdata/3/valysar.roff
  • roffio: 0.013
  • cxtgeo: 0.003

[codecov-commenter]

Codecov Report

Merging #954 (378f593) into main (69d8caa) will decrease coverage by 0.05%.
The diff coverage is 82.22%.

@@            Coverage Diff             @@
##             main     #954      +/-   ##
==========================================
- Coverage   80.57%   80.53%   -0.05%     
==========================================
  Files          91       91              
  Lines       13488    13501      +13     
  Branches     2224     2229       +5     
==========================================
+ Hits        10868    10873       +5     
- Misses       1899     1904       +5     
- Partials      721      724       +3     

Files	Coverage Δ
src/xtgeo/grid3d/grid_properties.py	86.22% <100.00%> (+0.31%)	⬆️
src/xtgeo/grid3d/_gridprops_import_roff.py	90.32% <85.71%> (-9.68%)	⬇️
src/xtgeo/grid3d/_grid3d_utils.py	85.08% <66.66%> (-5.83%)	⬇️

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[jcrivenaes]

I would the think the issue in #939 is the "<" letters, which I am pretty sure that Eclipse and friends will not allow in keywords.

We could probably seek to replace the C scan with roffio completely, but the GridProperties.scan_keywords() method has a return format that roffio cannot support.

If it is the byte position reports that are not supported, I think that is something which can be safely changed, and end users never will have use of that. Would it then be possible to scan with roffio completely?

[mferrera]

If it is the byte position reports that are not supported, I think that is something which can be safely changed, and end users never will have use of that. Would it then be possible to scan with roffio completely?

Yep!

It is specifically the strncmp(pname[j], "NAxxx", 2) != 0 condition that causes this fail; if the first two characters of pname[j] are "NA" this strncmp will return 0, so this condition won't be true and the parameter won't be added to the scanned list.

[jcrivenaes]

LGTM