netcdf-c/debug
Dennis Heimbigner 0b7a5382e7 Codify cross-platform file paths
The netcdf-c code has to deal with a variety of platforms:
Windows, OSX, Linux, Cygwin, MSYS, etc.  These platforms differ
significantly in the kind of file paths that they accept.  So in
order to handle this, I have created a set of replacements for
the most common file system operations such as _open_ or _fopen_
or _access_ to manage the file path differences correctly.

A more limited version of this idea was already implemented via
the ncwinpath.h and dwinpath.c code. So this can be viewed as a
replacement for that code. And in path in many cases, the only
change that was required was to replace '#include <ncwinpath.h>'
with '#include <ncpathmgt.h>' and then replace file operation
calls with the NCxxx equivalent from ncpathmgr.h Note that
recently, the ncwinpath.h was renamed ncpathmgmt.h, so this pull
request should not require dealing with winpath.

The heart of the change is include/ncpathmgmt.h, which provides
alternate operations such as NCfopen or NCaccess and which properly
parse and rebuild path arguments to work for the platform on which
the code is executing. This mostly matters for Windows because of the
way that it uses backslash and drive letters, as compared to *nix*.
One important feature is that the user can do string manipulations
on a file path without having to worry too much about the platform
because the path management code will properly handle most mixed cases.
So one can for example concatenate a path suffix that uses forward
slashes to a Windows path and have it work correctly.

The conversion code is in libdispatch/dpathmgr.c, and the
important function there is NCpathcvt which does the proper
conversions to the local path format.

As a rule, most code should just replace their file operations with
the corresponding NCxxx ones defined in include/ncpathmgmt.h. These
NCxxx functions all call NCpathcvt on their path arguments before
executing the actual file operation.

In some rare cases, the client may need to directly use NCpathcvt,
but this should be avoided as much as possible. If there is a need
for supporting a new file operation not already in ncpathmgmt.h, then
use the code in dpathmgr.c as a template. Also please notify Unidata
so we can include it as a formal part or our supported operations.
Also, if you see an operation in the library that is not using the
NCxxx form, then please submit an issue so we can fix it.

Misc. Changes:
* Clean up the utf8 testing code; it is impossible to get some
  tests to work under windows using shell scripts; the args do
  not pass as utf8 but as some other encoding.
* Added an extra utf8 test case: test_unicode_path.sh
* Add a true test for HDF5 1.10.6 or later because as noted in
  PR https://github.com/Unidata/netcdf-c/pull/1794,
  HDF5 changed its Windows file path handling.
2021-03-04 13:41:31 -07:00
..
dap4_test re: github issues 2018-10-30 20:48:12 -06:00
libdap2 re: github issues 2018-10-30 20:48:12 -06:00
libdap4 re: github issues 2018-10-30 20:48:12 -06:00
libdispatch re: github issues 2018-10-30 20:48:12 -06:00
libnczarr This PR adds EXPERIMENTAL support for accessing data in the 2020-06-28 18:02:47 -06:00
nc_test Change (again), and hopefully simplify, the file model inference algorithm. 2019-09-29 12:59:28 -06:00
nc_test4 re: github issues 2018-10-30 20:48:12 -06:00
ncdump re: github issues 2018-10-30 20:48:12 -06:00
ncgen re: github issues 2018-10-30 20:48:12 -06:00
oc2 re: github issues 2018-10-30 20:48:12 -06:00
cf Additional Fixes to NCZarr 2020-12-16 20:48:02 -07:00
cf.cmake Codify cross-platform file paths 2021-03-04 13:41:31 -07:00
clear re: github issues 2018-10-30 20:48:12 -06:00
gitpushoff.sh debug 2020-12-20 20:37:01 -07:00
gitpushon.sh Additional Fixes to NCZarr 2020-12-16 20:48:02 -07:00
install re: github issues 2018-10-30 20:48:12 -06:00
Make0 re: github issues 2018-10-30 20:48:12 -06:00
paths.sh re: github issues 2018-10-30 20:48:12 -06:00
README.txt Fix failings of nc_test/run_inmemory.sh 2018-12-04 19:22:02 -07:00
rebuild re: github issues 2018-10-30 20:48:12 -06:00
update updae 2020-05-07 20:40:25 -06:00

This directory contains various scripts for debugging by Dennis
Heimbigner @ Unidata.
DO NOT DELETE.
USE AT YOUR OWN PERIL.