mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-21 08:39:46 +08:00
6934aa2e8b
re: https://github.com/Unidata/netcdf-c/issues/1373 (partial) * Mark some global constants be const to indicate to make them easier to track. * Hide direct access to the ncrc_globalstate behind a function call. * Convert dispatch tables to constants (except the user defined ones) This has some consequences in terms of function arguments needing to be marked as const also. * Remove some no longer needed global fields * Aggregate all the globals in nclog.c * Uniformly replace nc_sizevector{0,1} with NC_coord_{zero,one} * Uniformly replace nc_ptrdffvector1 with NC_stride_one * Remove some obsolete code
117 lines
3.7 KiB
C
117 lines
3.7 KiB
C
/*
|
|
* Copyright 2018, University Corporation for Atmospheric Research
|
|
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
|
|
*/
|
|
|
|
#ifndef NCURI_H
|
|
#define NCURI_H
|
|
|
|
/* Define error codes */
|
|
#define NCU_OK (0)
|
|
#define NCU_EINVAL (1) /* Generic, mostly means bad argument */
|
|
#define NCU_EBADURL (2)
|
|
#define NCU_ENOMEM (3)
|
|
#define NCU_EPROTO (4)
|
|
#define NCU_EPATH (5)
|
|
#define NCU_EUSRPWD (6)
|
|
#define NCU_EHOST (7)
|
|
#define NCU_EPORT (8)
|
|
#define NCU_EPARAMS (9)
|
|
#define NCU_ENOPARAM (10)
|
|
#define NCU_ECONSTRAINTS (11)
|
|
|
|
/* Define flags to control what is included by ncuribuild*/
|
|
#define NCURIPATH 1
|
|
#define NCURIPWD 2
|
|
#define NCURIQUERY 4
|
|
#define NCURIFRAG 8
|
|
#define NCURIENCODE 16 /* If output should be encoded */
|
|
#define NCURIBASE (NCURIPWD|NCURIPATH)
|
|
#define NCURISVC (NCURIQUERY|NCURIBASE) /* for sending to server */
|
|
#define NCURIALL (NCURIPATH|NCURIPWD|NCURIQUERY|NCURIFRAG) /* for rebuilding after changes */
|
|
|
|
|
|
/*! This is an open structure meaning
|
|
it is ok to directly access its fields
|
|
*/
|
|
typedef struct NCURI {
|
|
char* uri; /* copy of url as passed by the caller */
|
|
char* protocol;
|
|
char* user; /* from user:password@ */
|
|
char* password; /* from user:password@ */
|
|
char* host; /*!< host*/
|
|
char* port; /*!< port */
|
|
char* path; /*!< path */
|
|
char* query; /*!< query */
|
|
char* fragment; /*!< fragment */
|
|
char** fraglist; /* envv style list of decomposed fragment*/
|
|
char** querylist; /* envv style list of decomposed query*/
|
|
#if 0
|
|
char* projection; /*!< without leading '?'*/
|
|
char* selection; /*!< with leading '&'*/
|
|
#endif
|
|
} NCURI;
|
|
|
|
/* Declaration modifiers for DLL support (MSC et al) */
|
|
#if defined(DLL_NETCDF) /* define when library is a DLL */
|
|
# if defined(DLL_EXPORT) /* define when building the library */
|
|
# define MSC_EXTRA __declspec(dllexport)
|
|
# else
|
|
# define MSC_EXTRA __declspec(dllimport)
|
|
# endif
|
|
# include <io.h>
|
|
#else
|
|
#define MSC_EXTRA /**< Needed for DLL build. */
|
|
#endif /* defined(DLL_NETCDF) */
|
|
|
|
#define EXTERNL MSC_EXTRA extern /**< Needed for DLL build. */
|
|
|
|
#if defined(_CPLUSPLUS_) || defined(__CPLUSPLUS__) || defined(__CPLUSPLUS)
|
|
extern "C" {
|
|
#endif
|
|
|
|
EXTERNL int ncuriparse(const char* s, NCURI** ncuri);
|
|
extern void ncurifree(NCURI* ncuri);
|
|
|
|
/* Replace the protocol */
|
|
extern int ncurisetprotocol(NCURI*,const char* newprotocol);
|
|
|
|
/* Replace the constraints */
|
|
EXTERNL int ncurisetquery(NCURI*,const char* query);
|
|
|
|
/* Construct a complete NC URI; caller frees returned string */
|
|
EXTERNL char* ncuribuild(NCURI*,const char* prefix, const char* suffix, int flags);
|
|
|
|
/*! Search the fragment for a given parameter
|
|
Null result => entry not found; !NULL=>found;
|
|
In any case, the result is imutable and should not be free'd.
|
|
*/
|
|
extern const char* ncurilookup(NCURI*, const char* param);
|
|
|
|
/*! Search the query for a given parameter
|
|
Null result => entry not found; !NULL=>found;
|
|
In any case, the result is imutable and should not be free'd.
|
|
*/
|
|
extern const char* ncuriquerylookup(NCURI*, const char* param);
|
|
|
|
/* Obtain the complete list of fragment pairs in envv format */
|
|
extern const char** ncurifragmentparams(NCURI*);
|
|
|
|
/* Obtain the complete list of query pairs in envv format */
|
|
extern const char** ncuriqueryparams(NCURI*);
|
|
|
|
/* URL Encode/Decode */
|
|
extern char* ncuridecode(char* s);
|
|
/* Partial decode */
|
|
extern char* ncuridecodepartial(char* s, const char* decodeset);
|
|
/* Encode using specified character set */
|
|
extern char* ncuriencodeonly(char* s, const char* allowable);
|
|
/* Encode user or pwd */
|
|
extern char* ncuriencodeuserpwd(char* s);
|
|
|
|
#if defined(_CPLUSPLUS_) || defined(__CPLUSPLUS__) || defined(__CPLUSPLUS)
|
|
}
|
|
#endif
|
|
|
|
#endif /*NCURI_H*/
|