csvfile.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_CSVFILE_H
#define LIBREPCB_CORE_CSVFILE_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class FilePath;
 
/*******************************************************************************
 *  Class CsvFile
 ******************************************************************************/
 
class CsvFile final {
  Q_DECLARE_TR_FUNCTIONS(CsvFile)
 
public:
  // Constructors / Destructor
  CsvFile() noexcept;
  CsvFile(const CsvFile& other) = delete;
  ~CsvFile() noexcept;
 
  const QString& getComment() const noexcept { return mComment; }
 
  const QStringList& getHeader() const noexcept { return mHeader; }
 
  const QList<QStringList>& getValues() const noexcept { return mValues; }
 
  void setComment(const QString& comment) noexcept;
 
  void setHeader(const QStringList& header) noexcept;
 
  void addValue(const QStringList& value);
 
  QString toString() const noexcept;
 
  void saveToFile(const FilePath& csvFp) const;
 
  // Operator Overloadings
  CsvFile& operator=(const CsvFile& rhs) = delete;
 
private:  // Methods
  QString getCommentLines() const noexcept;
  QString lineToString(const QStringList& line) const noexcept;
  static QString escapeValue(const QString& value) noexcept;
 
private:  // Data
  QString mComment;
  QStringList mHeader;
  QList<QStringList> mValues;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif