FixedLengthUtil.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file FixedLengthUtil.qm Qore user module for working with files with fixed lines length

/*  FixedLengthUtil.qm Copyright 2015 - 2016 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.
*/

// minimum required Qore version


/* see release notes below for version history
*/

namespace FixedLengthUtil {
    const EOL_UNIX = "\n";
    const EOL_WIN = "\r\n";
    const EOL_MACINTOSH = "\r";

    // helper hash (for O(ln(n)) lookups in the worst case) of end of line values
    const EOLS = (
        EOL_UNIX: True,
        EOL_WIN: True,
        EOL_MACINTOSH: True,
        );
};

class FixedLengthUtil::FixedLengthAbstractIterator {

public:
    private :
        hash m_specs;
        hash m_resolve_by_rule;
        string m_state;
        hash m_resolve_by_length;
        *hash m_opts; // encoding, eol, ignore_empty, timezone, etc

public:


    constructor(hash spec, *hash opts);


    abstract *string getLine();


    *hash getValue();


    any transform(any value, hash type);



    private *hash checkOptions(*hash opts);



    string identifyType(string input_line);



    *string identifyTypeImpl(string input_line);



    bool checkTransition(*string from, *string to);

};


class FixedLengthUtil::FixedLengthFileIterator : public FixedLengthUtil::FixedLengthAbstractIterator,public  Qore::FileLineIterator {

public:

    constructor(string file_name, hash spec, *hash opts) ;


    private string getLine();



    bool next();

};



class FixedLengthUtil::FixedLengthDataIterator : public FixedLengthUtil::FixedLengthAbstractIterator,public  Qore::DataLineIterator {

public:
    private :
        int position;
        int max_index;

        list lines;
        int lines_pos;

        string data;

public:


    constructor(string input_data, hash spec, *hash opts) ;



    bool next();

};


class FixedLengthUtil::FixedLengthAbstractWriter {

public:
    private :
        hash m_specs;
        string m_state;
        int m_linescount = 0;
        *hash m_opts;

public:


    constructor(hash specs, *hash opts);


    private *hash checkOptions(*hash opts);


    int linesCount();



    string formatLine(hash line);



    bool checkTransition(*string from, *string to);

};


class FixedLengthUtil::FixedLengthFileWriter : public FixedLengthUtil::FixedLengthAbstractWriter {

public:
    private :
        string file;
        File m_file();

public:


    constructor(string file_name, hash specs, *hash opts) ;


    string getFileName();



    write(hash line);



    write(list lines);



    write(Qore::AbstractIterator lines);

};



class FixedLengthUtil::FixedLengthDataWriter : public FixedLengthUtil::FixedLengthAbstractWriter {

public:

    constructor(hash specs, *hash opts) ;



    string write(list lines);



    string write(hash line);



    string write(Qore::AbstractIterator lines);

};