AbstractCsvWriter.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore AbstractCsvWriter class definition
 
/*  AbstractCsvWriter.qc Copyright 2012 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// assume local var scope, do not use "$" for vars, members, and method calls
 
namespace CsvUtil {
 
class AbstractCsvWriter : protected CsvHelper {
 
public:
protected:
            const Options = {
                "block": C_OPT1|C_OPT2,
                "datamap": C_OPT1,
                "date_format": C_OPT1|C_OPT2,
                "date-format": C_OPT1|C_OPT2,
                "encoding": C_OPT1|C_OPT2,
                "eol": C_OPT1|C_OPT2,
                "fields": C_OPT1,
                "headers": C_OPT1,
                "header_reorder": C_OPT1,
                "info_log": C_OPT1|C_OPT2,
                "number_format": C_OPT1|C_OPT2,
                "optimal_quotes": C_OPT1|C_OPT2,
                "optimal-quotes": C_OPT1|C_OPT2,
                "quote": C_OPT1|C_OPT2,
                "quote_escape": C_OPT1|C_OPT2,
                "separator": C_OPT1|C_OPT2,
                "verify_columns": C_OPT1|C_OPT2,
                "verify-columns": C_OPT1|C_OPT2,
                "write_headers": C_OPT1|C_OPT2,
                "write-headers": C_OPT1|C_OPT2,
            };
 
            string encoding;
 
            string separator = ",";
 
            string quote = "\"";
 
            string m_quoteEscapeChar = "\\";
 
            string eol = EOL_UNIX;
 
            bool checkElementCounts = False;
 
            int lineNo = 0;
 
            int block = 1000;
 
            string baseTemplate;
 
            bool write_headers = True;
 
            bool optimal_quotes = True;
 
            *code info_log;
 
            hash m_out_by_name;
 
            hash m_out_by_idx;
 
public:
 
 
        constructor(string n_errname, *hash<auto> n_opts);
 
 
 
        constructor(string n_errname, hash<auto> spec, hash<auto> n_opts);
 
 
        *hash<string, AbstractDataField> getRecordType();
 
 
protected:
         processCommonOptions(*hash<auto> n_opts, int C_OPTx);
public:
 
 
protected:
         processSpec();
public:
 
 
protected:
         writeHeaders();
public:
 
 
 
        writeLine(list<auto> values);
 
 
 
        writeLine(hash<auto> values);
 
 
 
        writeLine(string type, list<auto> values);
 
 
 
        writeLine(string type, hash<auto> values);
 
 
 
        write(Qore::AbstractIterator iterator);
 
 
 
        write(Qore::SQL::SQLStatement iterator);
 
 
 
        write(list<auto> l);
 
 
protected:
        abstract  writeRawLine(list<auto> values);
public:
 
 
protected:
         string prepareRawLine(list<auto> values);
public:
 
 
protected:
         string prepareRawLineIntern(list<auto> values);
public:
 
 
    }; // AbstractCsvWriter class
}; // CsvUtil namespace