Qore CsvUtil Module Reference 1.11
Loading...
Searching...
No Matches
CsvUtil.qm.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* CsvUtil.qm Copyright 2012 - 2024 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23*/
24
25// minimum required Qore version
26
27
28
29// assume local var scope, do not use "$" for vars, members, and method calls
30
31 ) + DataProviderActionCatalog::getActionOptionFromFields(
32 CsvReadDataProvider::ConstructorOptions - ("path", "data", "stream", "header_names"), {
33 "loc": "constructor",
34 }
35 ),
36 });
37 DataProviderActionCatalog::registerAction(<DataProviderActionInfo>{ "app": CsvUtil::AppName,
38 "path": "/",
39 "action": "read-data",
40 "subtype": "csvread",
41 "display_name": "Read CSV Inline Data",
42 "short_desc": "Read CSV inline data",
43 "desc": "Read CSV inline data",
44 "action_code": DPAT_FIND,
45 "cls": "CsvUtil::CsvReadDataProvider",
46 "options": DataProviderActionCatalog::getActionOptionFromFields( CsvReadDataProvider::ConstructorOptions{"data", "header_names"}, {
47 "preselected": True,
48 "required": True,
49 "loc": "constructor",
50 }
51 ) + DataProviderActionCatalog::getActionOptionFromFields(
52 CsvReadDataProvider::ConstructorOptions - ("path", "data", "strean", "header_names"), {
53 "loc": "constructor",
54 }
55 ),
56 });
57 DataProviderActionCatalog::registerAction(<DataProviderActionInfo>{ "app": CsvUtil::AppName,
58 "path": "/",
59 "action": "write",
60 "subtype": "csvwrite",
61 "display_name": "Write CSV Data",
62 "short_desc": "Write CSV file data to a specific file location",
63 "desc": "Write CSV file data to a specific file location",
64 "action_code": DPAT_CREATE,
65 "cls": "CsvUtil::CsvWriteDataProvider",
66 "options": DataProviderActionCatalog::getActionOptionFromFields( CsvWriteDataProvider::ConstructorOptions{"path",}, {
67 "preselected": True,
68 "required": True,
69 "loc": "constructor",
70 }
71 ) + DataProviderActionCatalog::getActionOptionFromFields(
72 CsvWriteDataProvider::ConstructorOptions - ("path",), {
73 "loc": "constructor",
74 }
75 ),
76 });
77 };
78}
79
80/* see release notes below for version history
81*/
82
390namespace CsvUtil {
392const AppName = "Csv";
393
395const EOL_UNIX = "\n";
397const EOL_WIN = "\r\n";
399const EOL_MACINTOSH = "\r";
400
401// helper list of end of line values
402const EOLS = (EOL_UNIX, EOL_WIN, EOL_MACINTOSH, );
403
405const CSV_TYPE_UNKNOWN = "<unknown>";
407const CSV_TYPE_SINGLE = "<single>";
408
411
414
415}; // CsvUtil namespace
416
417namespace Priv {
418const CsvWhiteLogo = ...;
419
420
421const CsvBlackLogo = ...;
422
423};
the CsvUtil namespace. All classes used in the CsvUtil module should be inside this namespace
Definition AbstractCsvIterator.qc.dox.h:28
const EOL_WIN
MS DOS/Windows end of line character sequence.
Definition CsvUtil.qm.dox.h:397
csvutil_set_global_compat_force_empty_string(softbool val)
sets the global_compat_force_empty_string variable to force "*string" fields with no value to ret...
const CSV_TYPE_SINGLE
Record type when multi-type is disabled.
Definition CsvUtil.qm.dox.h:407
const AppName
CSV app name.
Definition CsvUtil.qm.dox.h:392
bool global_compat_force_empty_string
global option to force "*string" fields with no value to return an empty string when parsing rath...
const EOL_MACINTOSH
Old (pre-OSX) Macintosh end of line character sequence.
Definition CsvUtil.qm.dox.h:399
const EOL_UNIX
Unix end of line character sequence (for new OS X too)
Definition CsvUtil.qm.dox.h:395
const CSV_TYPE_UNKNOWN
Record type when non matching any type.
Definition CsvUtil.qm.dox.h:405