A sphere with three ocean waves in differing shades of blue. Next to the sphere, there is the bolded text "Ocean Color". Under that, there are two acronyms, separated by a vertical pipe: OB.DAAC (Ocean Biology Distributed Active Archive Center) and OBPG (Ocean Biology Processing Group). Lorem ipsum dolor sit amet
NASA Logo
Ocean Color Science Software

ocssw V2022
clo.h
Go to the documentation of this file.
1 #ifndef CLO_H
2 #define CLO_H
3 
4 #include <stdio.h>
5 #include <inttypes.h>
6 
7 #ifdef __cplusplus
8 extern "C" {
9 #endif
10 
11 
69 #define CLO_CHUNK_SIZE 32
70 
72 #define CLO_ARRAY_DELIMITER " \t,:[]()\""
73 
74 // Define a silly string max length
75 #define SILLYSTRING 4096
76 
80 enum clo_dataType_t {
81  CLO_TYPE_BOOL,
82  CLO_TYPE_INT,
83  CLO_TYPE_INT64,
84  CLO_TYPE_FLOAT,
85  CLO_TYPE_DOUBLE,
86  CLO_TYPE_STRING,
87  CLO_TYPE_IFILE,
88  CLO_TYPE_OFILE,
89  CLO_TYPE_HELP,
90  CLO_TYPE_POSITION
91 };
92 
93 // forward reference for option structure
94 struct clo_option_t;
95 
101 typedef void (*clo_optionCallback_t)(struct clo_option_t *option);
102 
106 typedef struct clo_option_t {
107  char *key;
108  enum clo_dataType_t dataType;
109  char *defaultVal;
110  char *desc;
111  char *valStr;
112  char *source;
113  clo_optionCallback_t cb;
114  void *cb_data;
115  int cb_flag;
116  char **strArray;
117  void *valArray;
118  int count;
119  char **aliases;
120  int numAliases;
121  int aliasStorageSize;
122  int position;
123 } clo_option_t;
124 
126 typedef struct clo_optionList_t {
127  int storageSize;
128  int numOptions;
129  clo_option_t **options;
131  int positionStorageSize;
132  int positionNumOptions;
133  clo_option_t **positionOptions;
134 } clo_optionList_t;
135 
137 typedef struct clo_programMetadata_t {
138  char* tag;
139  char* value;
140 } clo_programMetadata_t;
141 
143 typedef struct clo_programMetadataList_t {
144  int storageSize;
145  int numEntries;
146  clo_programMetadata_t **entries;
147 } clo_programMetadataList_t;
148 
149 // global library settings
150 void clo_setIgnoreKeyCase(int val);
151 int clo_getIgnoreKeyCase();
152 
153 void clo_setEnableDumpOptions(int val);
154 int clo_getEnableDumpOptions();
155 
156 void clo_setEnableExtraOptions(int val);
157 int clo_getEnableExtraOptions();
158 
159 void clo_setVersion(const char *str);
160 void clo_setVersion2(const char* programName, const char* versionStr);
161 char* clo_getVersion();
162 
163 void clo_setHelpStr(const char *str);
164 char* clo_getHelpStr();
165 
166 void clo_setSelectOptionKeys(char *keys[]);
167 char **clo_getSelectOptionKeys();
168 
169 clo_optionList_t* clo_createList();
170 
171 clo_option_t* clo_createOption(const char *key, enum clo_dataType_t dataType,
172  const char *defaultVal, const char *desc);
173 void clo_addOptionAlias(clo_option_t *option, const char* alias);
174 void clo_addAlias(clo_optionList_t *list, const char *key, const char* alias);
175 void clo_insertOption(clo_optionList_t *list, clo_option_t *option);
176 clo_option_t* clo_addOption(clo_optionList_t *list, const char *key,
177  enum clo_dataType_t dataType, const char *defaultVal,
178  const char* desc);
179 clo_option_t* clo_copyOption(clo_option_t *option);
180 clo_optionList_t* clo_copyList(clo_optionList_t *list);
181 void clo_deleteOption(clo_option_t *option);
182 void clo_deleteList(clo_optionList_t *list);
183 clo_option_t* clo_getOption(clo_optionList_t *list, int i);
184 clo_option_t* clo_findOption(clo_optionList_t *list, const char *key);
185 int clo_getNumOptions(clo_optionList_t *list);
186 char* clo_getOptionRawString(clo_option_t *option);
187 
188 char* clo_getOptionString(clo_option_t *option);
189 int clo_getOptionBool(clo_option_t *option);
190 int clo_getOptionInt(clo_option_t *option);
191 int64_t clo_getOptionInt64(clo_option_t *option);
192 float clo_getOptionFloat(clo_option_t *option);
193 double clo_getOptionDouble(clo_option_t *option);
194 
195 char** clo_getOptionStrings(clo_option_t *option, int *count);
196 int* clo_getOptionBools(clo_option_t *option, int *count);
197 int* clo_getOptionInts(clo_option_t *option, int *count);
198 float* clo_getOptionFloats(clo_option_t *option, int *count);
199 double* clo_getOptionDoubles(clo_option_t *option, int *count);
200 
201 char* clo_getRawString(clo_optionList_t *list, const char *key);
202 char* clo_getString(clo_optionList_t *list, const char *key);
203 int clo_getBool(clo_optionList_t *list, const char *key);
204 int clo_getInt(clo_optionList_t *list, const char *key);
205 float clo_getFloat(clo_optionList_t *list, const char *key);
206 double clo_getDouble(clo_optionList_t *list, const char *key);
207 
208 char** clo_getStrings(clo_optionList_t *list, const char *key, int *count);
209 int* clo_getBools(clo_optionList_t *list, const char *key, int *count);
210 int* clo_getInts(clo_optionList_t *list, const char *key, int *count);
211 float* clo_getFloats(clo_optionList_t *list, const char *key, int *count);
212 double* clo_getDoubles(clo_optionList_t *list, const char *key, int *count);
213 
214 int clo_setOptionString(clo_option_t *option, const char *val, const char *source);
215 int clo_setString(clo_optionList_t *list, const char* key, const char *val, const char *source);
216 
217 // position option functions
218 void clo_setEnablePositionOptions(int val);
219 int clo_getEnablePositionOptions();
220 int clo_getPositionNumOptions(clo_optionList_t *list);
221 clo_option_t* clo_getPositionOption(clo_optionList_t *list, int i);
222 char* clo_getPositionString(clo_optionList_t *list, int pos);
223 
224 void clo_setEnableParOption(int val);
225 int clo_getEnableParOption();
226 
227 void clo_printOptionVal(clo_option_t *option);
228 void clo_printVals(clo_optionList_t *list);
229 void clo_printOption(clo_option_t *option);
230 void clo_printOptions(clo_optionList_t *list);
231 void clo_dumpOption(clo_option_t *option);
232 void clo_dumpOptions(clo_optionList_t *list);
233 void clo_printVersion();
234 void clo_printHelpString();
235 void clo_printUsage(clo_optionList_t *list);
236 
237 void clo_readString(clo_optionList_t *list, const char *str, const char *source);
238 void clo_readArgs(clo_optionList_t *list, int argc, char *argv[]);
239 void clo_readArgsPar(clo_optionList_t *list, int argc, char *argv[], int enableFileDescending);
240 void clo_readOptions(clo_optionList_t *list, clo_optionList_t *readList);
241 void clo_readFile(clo_optionList_t *list, const char *fileName);
242 
243 int clo_isOptionSet(clo_option_t *option);
244 int clo_isSet(clo_optionList_t *list, const char *key);
245 
246 int clo_writeParameterFile(clo_optionList_t *list, const char *filename);
247 
248 void clo_addXmlProgramMetadata(const char* tag, const char* value);
249 void clo_clearXmlProgramMetadata();
250 
251 void clo_writeXmlStartTag(FILE *fout, int level, const char *tag);
252 void clo_writeXmlEndTag(FILE *fout, int level, const char *tag);
253 void clo_writeXmlTag(FILE *fout, int level, const char *tag, const char *value);
254 int clo_writeXmlFile(clo_optionList_t *list, const char *filename);
255 
256 void clo_trimDashes(char* str);
257 char* clo_trimDashesDup(const char* str);
258 
259 //void clo_resetFileRecursion();
260 
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 
266 #endif
clo_getFloat
float clo_getFloat(clo_optionList_t *list, const char *key)
Definition: clo.c:1429
clo_printOptions
void clo_printOptions(clo_optionList_t *list)
Definition: clo.c:1931
clo_getOptionFloats
float * clo_getOptionFloats(clo_option_t *option, int *count)
Definition: clo.c:1295
clo_setIgnoreKeyCase
void clo_setIgnoreKeyCase(int val)
Definition: clo.c:389
clo_getStrings
char ** clo_getStrings(clo_optionList_t *list, const char *key, int *count)
Definition: clo.c:1469
value
int32 value
Definition: Granule.c:1235
clo_copyOption
clo_option_t * clo_copyOption(clo_option_t *option)
Definition: clo.c:741
clo_createList
clo_optionList_t * clo_createList()
Definition: clo.c:532
clo_programMetadataList_t::numEntries
int numEntries
Definition: clo.h:145
clo_option_t::defaultVal
char * defaultVal
Definition: clo.h:109
clo_getFloats
float * clo_getFloats(clo_optionList_t *list, const char *key, int *count)
Definition: clo.c:1538
clo_setEnableParOption
void clo_setEnableParOption(int val)
Definition: clo.c:1738
clo_option_t::position
int position
Definition: clo.h:122
clo_optionCallback_t
void(* clo_optionCallback_t)(struct clo_option_t *option)
Definition: clo.h:101
clo_optionList_t::storageSize
int storageSize
Definition: clo.h:127
clo_getDouble
double clo_getDouble(clo_optionList_t *list, const char *key)
Definition: clo.c:1447
CLO_TYPE_POSITION
@ CLO_TYPE_POSITION
Definition: clo.h:90
clo_getOptionDouble
double clo_getOptionDouble(clo_option_t *option)
Definition: clo.c:1195
clo_deleteList
void clo_deleteList(clo_optionList_t *list)
Definition: clo.c:875
clo_optionList_t::positionStorageSize
int positionStorageSize
Definition: clo.h:131
clo_copyList
clo_optionList_t * clo_copyList(clo_optionList_t *list)
Definition: clo.c:799
clo_writeXmlTag
void clo_writeXmlTag(FILE *fout, int level, const char *tag, const char *value)
Definition: clo.c:2410
clo_programMetadata_t
Definition: clo.h:137
clo_programMetadataList_t::storageSize
int storageSize
Definition: clo.h:144
CLO_TYPE_DOUBLE
@ CLO_TYPE_DOUBLE
Definition: clo.h:85
clo_option_t::key
char * key
Definition: clo.h:107
clo_getOptionBools
int * clo_getOptionBools(clo_option_t *option, int *count)
Definition: clo.c:1251
clo_printUsage
void clo_printUsage(clo_optionList_t *list)
Definition: clo.c:1988
clo_programMetadata_t::tag
char * tag
Definition: clo.h:138
clo_printOptionVal
void clo_printOptionVal(clo_option_t *option)
Definition: clo.c:1756
clo_writeXmlFile
int clo_writeXmlFile(clo_optionList_t *list, const char *filename)
Definition: clo.c:2568
clo_getInts
int * clo_getInts(clo_optionList_t *list, const char *key, int *count)
Definition: clo.c:1515
clo_option_t::numAliases
int numAliases
Definition: clo.h:120
clo_clearXmlProgramMetadata
void clo_clearXmlProgramMetadata()
Definition: clo.c:2361
pos
float32 * pos
Definition: l1_czcs_hdf.c:35
clo_trimDashesDup
char * clo_trimDashesDup(const char *str)
Definition: clo.c:954
clo_getOptionInt64
int64_t clo_getOptionInt64(clo_option_t *option)
Definition: clo.c:1140
clo_getOptionDoubles
double * clo_getOptionDoubles(clo_option_t *option, int *count)
Definition: clo.c:1317
clo_setVersion
void clo_setVersion(const char *str)
Definition: clo.c:448
clo_getOptionRawString
char * clo_getOptionRawString(clo_option_t *option)
Definition: clo.c:1030
CLO_TYPE_FLOAT
@ CLO_TYPE_FLOAT
Definition: clo.h:84
clo_createOption
clo_option_t * clo_createOption(const char *key, enum clo_dataType_t dataType, const char *defaultVal, const char *desc)
Definition: clo.c:585
clo_isOptionSet
int clo_isOptionSet(clo_option_t *option)
Definition: clo.c:2257
clo_option_t::aliases
char ** aliases
Definition: clo.h:119
clo_setSelectOptionKeys
void clo_setSelectOptionKeys(char *keys[])
clo_option_t::aliasStorageSize
int aliasStorageSize
Definition: clo.h:121
clo_findOption
clo_option_t * clo_findOption(clo_optionList_t *list, const char *key)
Definition: clo.c:967
clo_readFile
void clo_readFile(clo_optionList_t *list, const char *fileName)
Definition: clo.c:2210
clo_getBools
int * clo_getBools(clo_optionList_t *list, const char *key, int *count)
Definition: clo.c:1492
clo_addAlias
void clo_addAlias(clo_optionList_t *list, const char *key, const char *alias)
Definition: clo.c:646
clo_trimDashes
void clo_trimDashes(char *str)
Definition: clo.c:918
clo_getRawString
char * clo_getRawString(clo_optionList_t *list, const char *key)
Definition: clo.c:1339
clo_printVersion
void clo_printVersion()
Definition: clo.c:1968
CLO_TYPE_BOOL
@ CLO_TYPE_BOOL
Definition: clo.h:81
clo_option_t::strArray
char ** strArray
Definition: clo.h:116
clo_readArgsPar
void clo_readArgsPar(clo_optionList_t *list, int argc, char *argv[], int enableFileDescending)
Definition: clo.c:2119
clo_dumpOptions
void clo_dumpOptions(clo_optionList_t *list)
Definition: clo.c:1999
clo_printHelpString
void clo_printHelpString()
Definition: clo.c:1978
clo_getString
char * clo_getString(clo_optionList_t *list, const char *key)
Definition: clo.c:1357
clo_getHelpStr
char * clo_getHelpStr()
Definition: clo.c:501
CLO_TYPE_INT64
@ CLO_TYPE_INT64
Definition: clo.h:83
clo_programMetadataList_t::entries
clo_programMetadata_t ** entries
Definition: clo.h:146
clo_deleteOption
void clo_deleteOption(clo_option_t *option)
Definition: clo.c:823
clo_getEnableParOption
int clo_getEnableParOption()
Definition: clo.c:1747
clo_getEnableDumpOptions
int clo_getEnableDumpOptions()
Definition: clo.c:419
clo_optionList_t
Definition: clo.h:126
clo_option_t::cb
clo_optionCallback_t cb
Definition: clo.h:113
clo_getBool
int clo_getBool(clo_optionList_t *list, const char *key)
Definition: clo.c:1375
clo_getInt
int clo_getInt(clo_optionList_t *list, const char *key)
Definition: clo.c:1393
clo_readOptions
void clo_readOptions(clo_optionList_t *list, clo_optionList_t *readList)
Definition: clo.c:2173
list
list(APPEND LIBS ${NETCDF_LIBRARIES}) find_package(GSL REQUIRED) include_directories($
Definition: CMakeLists.txt:8
clo_optionList_t::options
clo_option_t ** options
Definition: clo.h:129
clo_option_t::valStr
char * valStr
Definition: clo.h:111
CLO_TYPE_INT
@ CLO_TYPE_INT
Definition: clo.h:82
clo_option_t
Definition: clo.h:106
clo_getOptionStrings
char ** clo_getOptionStrings(clo_option_t *option, int *count)
Definition: clo.c:1226
clo_dumpOption
void clo_dumpOption(clo_option_t *option)
Definition: clo.c:1896
oci_hdr_strip.argc
argc
Definition: oci_hdr_strip.py:7
clo_setEnableDumpOptions
void clo_setEnableDumpOptions(int val)
Definition: clo.c:410
CLO_TYPE_IFILE
@ CLO_TYPE_IFILE
Definition: clo.h:87
filename
char filename[FILENAME_MAX]
Definition: atrem_corl1.h:122
clo_printVals
void clo_printVals(clo_optionList_t *list)
Definition: clo.c:1845
CLO_TYPE_OFILE
@ CLO_TYPE_OFILE
Definition: clo.h:88
clo_getSelectOptionKeys
char ** clo_getSelectOptionKeys()
Definition: clo.c:523
clo_getEnableExtraOptions
int clo_getEnableExtraOptions()
Definition: clo.c:439
clo_getOptionString
char * clo_getOptionString(clo_option_t *option)
Definition: clo.c:1050
clo_getDoubles
double * clo_getDoubles(clo_optionList_t *list, const char *key, int *count)
Definition: clo.c:1561
clo_getOptionInts
int * clo_getOptionInts(clo_option_t *option, int *count)
Definition: clo.c:1273
clo_setVersion2
void clo_setVersion2(const char *programName, const char *versionStr)
Definition: clo.c:464
clo_insertOption
void clo_insertOption(clo_optionList_t *list, clo_option_t *option)
Definition: clo.c:666
clo_getPositionNumOptions
int clo_getPositionNumOptions(clo_optionList_t *list)
Definition: clo.c:1704
clo_option_t::count
int count
Definition: clo.h:118
CLO_TYPE_HELP
@ CLO_TYPE_HELP
Definition: clo.h:89
mapgen.level
level
Definition: mapgen.py:188
clo_option_t::desc
char * desc
Definition: clo.h:110
clo_writeXmlEndTag
void clo_writeXmlEndTag(FILE *fout, int level, const char *tag)
Definition: clo.c:2395
clo_option_t::valArray
void * valArray
Definition: clo.h:117
clo_getNumOptions
int clo_getNumOptions(clo_optionList_t *list)
Definition: clo.c:1017
clo_optionList_t::numOptions
int numOptions
Definition: clo.h:128
l1aextract_netcdf.versionStr
string versionStr
Definition: l1aextract_netcdf.py:18
clo_addXmlProgramMetadata
void clo_addXmlProgramMetadata(const char *tag, const char *value)
Definition: clo.c:2345
clo_option_t::cb_flag
int cb_flag
Definition: clo.h:115
clo_readString
void clo_readString(clo_optionList_t *list, const char *str, const char *source)
Definition: clo.c:2019
clo_setEnableExtraOptions
void clo_setEnableExtraOptions(int val)
Definition: clo.c:429
clo_setString
int clo_setString(clo_optionList_t *list, const char *key, const char *val, const char *source)
Definition: clo.c:1667
clo_writeParameterFile
int clo_writeParameterFile(clo_optionList_t *list, const char *filename)
Definition: clo.c:2287
clo_getOptionBool
int clo_getOptionBool(clo_option_t *option)
Definition: clo.c:1087
clo_printOption
void clo_printOption(clo_option_t *option)
Definition: clo.c:1865
clo_getEnablePositionOptions
int clo_getEnablePositionOptions()
Definition: clo.c:1695
clo_optionList_t::positionNumOptions
int positionNumOptions
Definition: clo.h:132
clo_getOption
clo_option_t * clo_getOption(clo_optionList_t *list, int i)
Definition: clo.c:908
clo_option_t::source
char * source
Definition: clo.h:112
clo_option_t::cb_data
void * cb_data
Definition: clo.h:114
clo_getPositionString
char * clo_getPositionString(clo_optionList_t *list, int pos)
Definition: clo.c:1723
clo_getPositionOption
clo_option_t * clo_getPositionOption(clo_optionList_t *list, int i)
Definition: clo.c:1716
clo_readArgs
void clo_readArgs(clo_optionList_t *list, int argc, char *argv[])
Definition: clo.c:2103
clo_addOption
clo_option_t * clo_addOption(clo_optionList_t *list, const char *key, enum clo_dataType_t dataType, const char *defaultVal, const char *desc)
Definition: clo.c:684
clo_option_t::dataType
enum clo_dataType_t dataType
Definition: clo.h:108
clo_optionList_t::positionOptions
clo_option_t ** positionOptions
Definition: clo.h:133
clo_getOptionFloat
float clo_getOptionFloat(clo_option_t *option)
Definition: clo.c:1167
clo_dataType_t
clo_dataType_t
Definition: clo.h:80
clo_getVersion
char * clo_getVersion()
Definition: clo.c:478
i
int i
Definition: decode_rs.h:71
clo_isSet
int clo_isSet(clo_optionList_t *list, const char *key)
Definition: clo.c:2270
CLO_TYPE_STRING
@ CLO_TYPE_STRING
Definition: clo.h:86
clo_getIgnoreKeyCase
int clo_getIgnoreKeyCase()
Definition: clo.c:401
clo_setEnablePositionOptions
void clo_setEnablePositionOptions(int val)
Definition: clo.c:1685
clo_getOptionInt
int clo_getOptionInt(clo_option_t *option)
Definition: clo.c:1113
str
Definition: aerosol.c:136
clo_addOptionAlias
void clo_addOptionAlias(clo_option_t *option, const char *alias)
Definition: clo.c:632
clo_setOptionString
int clo_setOptionString(clo_option_t *option, const char *val, const char *source)
Definition: clo.c:1579
clo_writeXmlStartTag
void clo_writeXmlStartTag(FILE *fout, int level, const char *tag)
Definition: clo.c:2381
clo_setHelpStr
void clo_setHelpStr(const char *str)
Definition: clo.c:487
clo_programMetadataList_t
Definition: clo.h:143
count
int count
Definition: decode_rs.h:79
clo_programMetadata_t::value
char * value
Definition: clo.h:139


ABOUT

Our Team

Contact Us

DATA

Get Started

Find Data

Use Data

TOOLS

SeaBASS

SeaDAS

Giovanni Data Visualizer

Worldview Mapping Interface

Mission Quality Monitor

HELP

How to Use Earthdata Search

Level 3 & 4 Browser Help

File Search Help

Search & Download Help

Earthdata Forum

Join Mailing List

How to Cite Data

CONNECT WITH US
COMPLIANCE

Web Privacy Policy

Data & Information Policy

Communications Policy

Accessibility

Freedom of Information Act

USA.gov

Responsible NASA Official: Sean Bailey
Curator: OceanColor Webmaster