/***************************************************************************
 *                                                                         *
 *   Copyright : (C) 2010 The University of Toronto                        *
 *   email     : netterfield@astro.utoronto.ca                             *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#include "asciisourceconfig.h"

#include "asciisource.h"
#include "datasource.h"

//
// AsciiSourceConfig
//


#define DEFAULT_COMMENT_DELIMITERS "#"
#define DEFAULT_COLUMN_WIDTH 16


const char AsciiSourceConfig::Key_fileNamePattern[] = "Filename Pattern";
const char AsciiSourceConfig::Tag_fileNamePattern[] = "filenamepattern";
const char AsciiSourceConfig::Key_delimiters[] = "Comment Delimiters";
const char AsciiSourceConfig::Tag_delimiters[] = "delimiters";
const char AsciiSourceConfig::Key_indexVector[] ="Index";
const char AsciiSourceConfig::Tag_indexVector[] ="vector";
const char AsciiSourceConfig::Key_indexInterpretation[] = "Default INDEX Interpretation";
const char AsciiSourceConfig::Tag_indexInterpretation[] = "interpretation";
const char AsciiSourceConfig::Key_timeAsciiFormatString[] = "ASCII Time format";
const char AsciiSourceConfig::Tag_timeAsciiFormatString[] = "asciiTimeFormat";
const char AsciiSourceConfig::Key_columnType[] = "Column Type";
const char AsciiSourceConfig::Tag_columnType[] = "columntype";
const char AsciiSourceConfig::Key_columnDelimiter[] = "Column Delimiter";
const char AsciiSourceConfig::Tag_columnDelimiter[] = "columndelimiter";
const char AsciiSourceConfig::Key_columnWidth[] = "Column Width";
const char AsciiSourceConfig::Tag_columnWidth[] = "columnwidth";
const char AsciiSourceConfig::Key_columnWidthIsConst[] = "Column Width is const";
const char AsciiSourceConfig::Tag_columnWidthIsConst[] = "columnwidthisconst";
const char AsciiSourceConfig::Key_dataLine[] = "Data Start";
const char AsciiSourceConfig::Tag_dataLine[] = "headerstart";
const char AsciiSourceConfig::Key_readFields[] = "Read Fields";
const char AsciiSourceConfig::Tag_readFields[] = "readfields";
const char AsciiSourceConfig::Key_readUnits[] = "Read Units";
const char AsciiSourceConfig::Tag_readUnits[] = "readunits";
const char AsciiSourceConfig::Key_useDot[] = "Use Dot";
const char AsciiSourceConfig::Tag_useDot[] = "usedot";
const char AsciiSourceConfig::Key_fieldsLine[] = "Fields Line";
const char AsciiSourceConfig::Tag_fieldsLine[] = "fields";
const char AsciiSourceConfig::Key_unitsLine[] = "Units Line";
const char AsciiSourceConfig::Tag_unitsLine[] = "units";
const char AsciiSourceConfig::Key_limitFileBuffer[] = "Limit file buffer size";
const char AsciiSourceConfig::Tag_limitFileBuffer[] = "limitFileBuffer";
const char AsciiSourceConfig::Key_limitFileBufferSize[] = "Size of limited file buffer";
const char AsciiSourceConfig::Tag_limitFileBufferSize[] = "limitFileBufferSize";
const char AsciiSourceConfig::Key_useThreads[] = "Use threads when parsing Ascii data";
const char AsciiSourceConfig::Tag_useThreads[] = "useThreads";
const char AsciiSourceConfig::Key_dataRate[] = "Data Rate for index";
const char AsciiSourceConfig::Tag_dataRate[] = "dataRate";
const char AsciiSourceConfig::Key_offsetDateTime[] = "use an explicit date/time offset";
const char AsciiSourceConfig::Tag_offsetDateTime[] = "offsetDateTime";
const char AsciiSourceConfig::Key_offsetFileDate[] = "use file time/date as offset";
const char AsciiSourceConfig::Tag_offsetFileDate[] = "offsetFileDate";
const char AsciiSourceConfig::Key_offsetRelative[] = "use relative file time offset";
const char AsciiSourceConfig::Tag_offsetRelative[] = "offsetRelavive";
const char AsciiSourceConfig::Key_dateTimeOffset[] = "date/time offset";
const char AsciiSourceConfig::Tag_dateTimeOffset[] = "dateTimeOffset";
const char AsciiSourceConfig::Key_relativeOffset[] = "relative offset";
const char AsciiSourceConfig::Tag_relativeOffset[] = "relativeOffset";
const char AsciiSourceConfig::Key_nanValue[] = "NaN value";
const char AsciiSourceConfig::Tag_nanValue[] = "nanValue";
const char AsciiSourceConfig::Key_updateType[] = "updateType";
const char AsciiSourceConfig::Tag_updateType[] = "updateType";

AsciiSourceConfig::AsciiSourceConfig() :
  _delimiters(DEFAULT_COMMENT_DELIMITERS),
  _indexVector("INDEX"),
  _indexInterpretation(Unknown),
  _timeAsciiFormatString("hh:mm:ss.zzz"),
  _fileNamePattern(""),
  _columnType(Whitespace),
  _columnDelimiter(","),
  _columnWidth(DEFAULT_COLUMN_WIDTH),
  _columnWidthIsConst(false),
  _dataLine(0),
  _readFields(false),
  _readUnits(false),
  _fieldsLine(0),
  _unitsLine(0),
  _useDot(true),
  _limitFileBuffer(false),
  _limitFileBufferSize(100),
  _useThreads(false),
  _dataRate(1.0),
  _offsetDateTime(false),
  _offsetFileDate(false),
  _offsetRelative(true),
  _dateTimeOffset(QDateTime::currentDateTime()),
  _relativeOffset(0),
  _nanValue(0),
  _updateType(Kst::DataSource::Timer)
{
}



void AsciiSourceConfig::save(QSettings& cfg) const {
  _fileNamePattern >> cfg;
  _indexVector >> cfg;
  _delimiters >> cfg;
  _indexInterpretation >> cfg;
  _columnType >> cfg;
  _columnDelimiter >> cfg;
  _columnWidth >> cfg;
  _dataLine >> cfg;
  _readFields >> cfg;
  _useDot >> cfg;
  _fieldsLine >> cfg;
  _columnWidthIsConst >> cfg;
  _readUnits >> cfg;
  _unitsLine >> cfg;
  _limitFileBuffer >> cfg;
  _limitFileBufferSize >> cfg;
  _useThreads >> cfg;
  _timeAsciiFormatString >> cfg;
  _dataRate >> cfg;
  _offsetDateTime >> cfg;
  _offsetFileDate >> cfg;
  _offsetRelative >> cfg;
  _dateTimeOffset >> cfg;
  _relativeOffset >> cfg;
  _nanValue >> cfg;
  _updateType >> cfg;
}


void AsciiSourceConfig::saveDefault(QSettings& cfg) const {
  cfg.beginGroup(AsciiSource::asciiTypeKey());
  save(cfg);
  cfg.endGroup();
}


void AsciiSourceConfig::saveGroup(QSettings& cfg, const QString& fileName) const {
  if (fileName.isEmpty())
    return;
  cfg.beginGroup(AsciiSource::asciiTypeKey());
  cfg.beginGroup(fileName);
  save(cfg);
  cfg.endGroup();
  cfg.endGroup();
}


void AsciiSourceConfig::read(QSettings& cfg) {
  _fileNamePattern << cfg;
  _indexVector << cfg;
  _delimiters << cfg;
  _indexInterpretation << cfg;
  _columnType << cfg;
  _columnDelimiter << cfg;
  _columnWidth << cfg;
  _dataLine << cfg;
  _readFields << cfg;
  _useDot << cfg;
  _fieldsLine << cfg;
  _columnWidthIsConst << cfg;
  _readUnits << cfg;
  _unitsLine << cfg;
  _limitFileBuffer << cfg;
  _limitFileBufferSize << cfg;
  _useThreads << cfg;
  _timeAsciiFormatString << cfg;
  _dataRate << cfg;
  _offsetDateTime << cfg;
  _offsetFileDate << cfg;
  _offsetRelative << cfg;
  _dateTimeOffset << cfg;
  _relativeOffset << cfg;
  _nanValue << cfg;
  _updateType << cfg;
}


const AsciiSourceConfig& AsciiSourceConfig::readGroup(QSettings& cfg, const QString& fileName) {
  cfg.beginGroup(AsciiSource::asciiTypeKey());
  read(cfg);
  if (!fileName.isEmpty()) {
    cfg.beginGroup(fileName);
    read(cfg);
    cfg.endGroup();
  }
  _delimiters = QRegExp::escape(_delimiters).toLatin1();
  cfg.endGroup();
  return *this;
}


void AsciiSourceConfig::save(QXmlStreamWriter& s) {
  s.writeStartElement("properties");
  if (_indexInterpretation != AsciiSourceConfig::Unknown) {
    _indexVector >> s;
    _indexInterpretation >> s;
  }
  _delimiters >> s;

  _columnType >> s;
  if (_columnType == Fixed) {
    _columnWidth >> s;
  } else if (_columnType == Custom) {
      _columnDelimiter >> s;
  }

  _dataLine >> s;
  _fieldsLine >> s;
  _readFields >> s;
  _useDot >> s;
  _columnWidthIsConst >> s;
  _readUnits >> s;
  _unitsLine >> s;
  _limitFileBuffer >> s;
  _limitFileBufferSize >> s;
  _useThreads >> s;
  _timeAsciiFormatString >> s;
  _dataRate >> s;
  _offsetDateTime >> s;
  _offsetFileDate >> s;
  _offsetRelative >> s;
  _dateTimeOffset >> s;
  _relativeOffset >> s;
  _nanValue >> s;
  _updateType >> s;
  s.writeEndElement();
}


void AsciiSourceConfig::parseProperties(QXmlStreamAttributes& attributes) {
  _fileNamePattern << attributes;
  _indexVector << attributes;
  _delimiters << attributes;
  _indexInterpretation << attributes;
  _columnType << attributes;
  _columnDelimiter << attributes;
  _columnWidth << attributes;
  _dataLine << attributes;
  _readFields << attributes;
  _useDot << attributes;
  _fieldsLine << attributes;
  _columnWidthIsConst << attributes;
  _readUnits << attributes;
  _unitsLine << attributes;
  _limitFileBuffer << attributes;
  _limitFileBufferSize << attributes;
  _useThreads << attributes;
  _timeAsciiFormatString << attributes;
  _dataRate << attributes;
  _offsetDateTime << attributes;
  _offsetFileDate << attributes;
  _offsetRelative << attributes;
  _dateTimeOffset << attributes;
  _relativeOffset << attributes;
  _nanValue << attributes;
  _updateType << attributes;
}


void AsciiSourceConfig::load(const QDomElement& e) {
  QDomNode n = e.firstChild();
  while (!n.isNull()) {
    QDomElement elem = n.toElement();
    if (!elem.isNull()) {
      if (elem.tagName() == "properties") {
        _fileNamePattern << elem;
        _indexVector << elem;
        _delimiters << elem;
        _indexInterpretation << elem;
        _columnType << elem;
        _columnDelimiter << elem;
        _columnWidth << elem;
        _dataLine << elem;
        _readFields << elem;
        _useDot << elem;
        _fieldsLine << elem;
        _columnWidthIsConst << elem;
        _readUnits << elem;
        _unitsLine << elem;
        _limitFileBuffer << elem;
        _limitFileBufferSize << elem;
        _useThreads << elem;
        _timeAsciiFormatString << elem;
        _dataRate << elem;
        _offsetDateTime << elem;
        _offsetFileDate << elem;
        _offsetRelative << elem;
        _dateTimeOffset << elem;
        _relativeOffset << elem;
        _nanValue << elem;
        _updateType << elem;
      }
    }
    n = n.nextSibling();
  }
}


bool AsciiSourceConfig::operator==(const AsciiSourceConfig& rhs) const
{
  return _fileNamePattern == rhs._fileNamePattern &&
      _indexVector == rhs._indexVector &&
      _delimiters == rhs._delimiters &&
      _indexInterpretation == rhs._indexInterpretation &&
      _columnType == rhs._columnType &&
      _columnDelimiter == rhs._columnDelimiter &&
      _columnWidth == rhs._columnWidth &&
      _dataLine == rhs._dataLine &&
      _readFields == rhs._readFields &&
      _useDot == rhs._useDot &&
      _fieldsLine == rhs._fieldsLine &&
      _columnWidthIsConst == rhs._columnWidthIsConst &&
      _readUnits == rhs._readUnits &&
      _unitsLine == rhs._unitsLine &&
      _limitFileBuffer == rhs._limitFileBuffer &&
      _limitFileBufferSize == rhs._limitFileBufferSize &&
      _useThreads == rhs._useThreads &&
      _timeAsciiFormatString == rhs._timeAsciiFormatString &&
      _dataRate == rhs._dataRate &&
      _offsetDateTime == rhs._offsetDateTime &&
      _offsetFileDate == rhs._offsetFileDate &&
      _offsetRelative == rhs._offsetRelative &&
      _dateTimeOffset == rhs._dateTimeOffset &&
      _relativeOffset == rhs._relativeOffset &&
      _nanValue == rhs._nanValue &&
      _updateType == rhs._updateType;

}

bool AsciiSourceConfig::operator!=(const AsciiSourceConfig& rhs) const
{
  return !operator==(rhs);
}

bool AsciiSourceConfig::isUpdateNecessary(const AsciiSourceConfig& rhs) const
{
  return _fileNamePattern != rhs._fileNamePattern ||
      _indexVector != rhs._indexVector ||
      _delimiters != rhs._delimiters ||
      _indexInterpretation != rhs._indexInterpretation ||
      _columnType != rhs._columnType ||
      _columnDelimiter != rhs._columnDelimiter ||
      _columnWidth != rhs._columnWidth ||
      _dataLine != rhs._dataLine ||
      _readFields != rhs._readFields ||
      _useDot != rhs._useDot ||
      _fieldsLine != rhs._fieldsLine ||
      _columnWidthIsConst != rhs._columnWidthIsConst ||
      _readUnits != rhs._readUnits ||
      _unitsLine != rhs._unitsLine ||
      _timeAsciiFormatString != rhs._timeAsciiFormatString ||
      _dataRate != rhs._dataRate ||
      _offsetDateTime != rhs._offsetDateTime ||
      _offsetFileDate != rhs._offsetFileDate ||
      _offsetRelative != rhs._offsetRelative ||
      _dateTimeOffset != rhs._dateTimeOffset ||
      _relativeOffset != rhs._relativeOffset ||
      _nanValue != rhs._nanValue;
}



