CSVImportConfigurationWidget.h

/*
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip 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.
 *
 */
///@cond DOXYGEN_HIDDEN

#ifndef CSVIMPORTCONFIGURATIONWIDGET_H
#define CSVIMPORTCONFIGURATIONWIDGET_H

#include <QWidget>
#include <QValidator>
#include <QTableWidget>

#include <tulip/CSVContentHandler.h>
#include <tulip/tulipconf.h>

class QComboBox;
class QCheckBox;
class QValidator;
class QLineEdit;

namespace Ui {
class CSVImportConifgurationWidget;
}

namespace tlp {
class CSVParser;
class CSVImportParameters;
class CSVColumn;

/**
 * @brief Configuration widget for a property.
 */
class TLP_QT_SCOPE PropertyConfigurationWidget: public QWidget {
  Q_OBJECT
public:
  PropertyConfigurationWidget(unsigned int propertyNumber, const QString& propertyName, bool propertyNameIsEditable,
                              const std::string& PropertyType, QWidget* parent = NULL);
  /**
     * Return the selected property type. The property type is not the label displayed in the combobox but correspond to the Property::propertyTypename static string variable of the property class.
     */
  std::string getPropertyType() const;
  /**
    * @brief Change the type of the property. Use the PropertyClass::propertyTypename static var.
    **/
  void setPropertyType(const std::string& propertyType);

  QString getPropertyName() const;
  bool getPropertyUsed() const;
  /**
     *  @brief Set the property name validator. Use to chek if entered graph name is valid.
     */
  void setPropertyNameValidator(QValidator* validator);
  unsigned int getPropertyNumber() const;

  QLineEdit *getNameLineEdit() {
    return propertyNameLineEdit;
  }
  QComboBox *getTypeComboBox() {
    return propertyTypeComboBox;
  }

  QCheckBox *getCheckBox() {
    return usedCheckBox;
  }

private:
  void fillPropertyTypeComboBox();
  QLineEdit *propertyNameLineEdit;
  QComboBox *propertyTypeComboBox;
  QCheckBox *usedCheckBox;
  bool nameEditable;
  unsigned int propertyNumber;

private slots:
  void nameEditFinished();
  void useStateChanged(int state);

signals:
  void propertyNameChange(QString newName);
  void stateChange(bool state);
};

/**
 * @brief Check if the property name already exist in the property list.
 **/
class TLP_QT_SCOPE PropertyNameValidator: public QValidator {
public:
  PropertyNameValidator(const std::vector<PropertyConfigurationWidget*>& widgets,QObject*parent=NULL) :
    QValidator(parent), widgets(widgets) {
  }
  virtual ~PropertyNameValidator() {

  }

  /**
   * Validate the new property name. Check if any property does not have the same name
   */
  QValidator::State validate(QString & input, int & pos) const;

private:
  const std::vector<PropertyConfigurationWidget*>& widgets;
};

/**
* @brief Simple table preview of CSV file. Load in a QTableWidget the data send by a CSVContentHandler.
**/
class TLP_QT_SCOPE CSVTableWidget : public QTableWidget, public CSVContentHandler {
public:
  CSVTableWidget(QWidget* parent=NULL);
  void begin();
  void line(unsigned int row,const std::vector<std::string>& lineTokens);
  void end(unsigned int rowNumber, unsigned int columnNumber);
  /**
    * @brief Limit the line number of the preview. Need to parse the file again to take this limit in account.
    **/
  void setMaxPreviewLineNumber(unsigned int lineNumber) {
    maxLineNumber = lineNumber;
  }

  /**
    * @brief Get the preview line number.
    **/
  unsigned int getMaxPreviewLineNumber()const {
    return maxLineNumber;
  }

  unsigned int getFirstLineIndex() {
    return firstLineIndex;
  }

  void setFirstLineIndex(unsigned int index) {
    firstLineIndex = index;
  }

private:
  unsigned int maxLineNumber;
  unsigned int firstLineIndex;
};


/**
  * @brief Widget generating a CSVImportParameters object configuring the CSV import process.
  *
  * Use a CSV parser to fill this widget with previews and CSV file statistics like number of rows and columns.
  **/
class TLP_QT_SCOPE CSVImportConfigurationWidget : public QWidget, public CSVContentHandler {
  Q_OBJECT
public:
  CSVImportConfigurationWidget(QWidget *parent = NULL);
  ~CSVImportConfigurationWidget();
  void begin();
  void line(unsigned int row,const std::vector<std::string>& lineTokens);
  void end(unsigned int rowNumber, unsigned int columnNumber);

  /**
    * @brief Update the widget contents with the new file parser.
    **/
  void setNewParser(tlp::CSVParser *parser);

  /**
  * @brief Get the import parameters.
  *
  * Use this object to configure import process of the CSVImportGraph object.
  **/
  CSVImportParameters getImportParameters()const;

  bool eventFilter(QObject *, QEvent *);


protected:

  void updateWidget();

  std::vector<CSVColumn> getPropertiesToImport()const;

  void updateLineNumbers(bool resetValues);

  bool useFirstLineAsPropertyName()const;
  void setUseFirstLineAsPropertyName(bool useFirstLineAsHeader)const;
  unsigned int rowCount()const;
  unsigned int columnCount()const;


  /**
  *@brief The index of the first line to get in the file.
  *@brief A line number from 0 to LastLineIndex.
  **/
  unsigned int getFirstLineIndex()const;

  /**
    * @brief The index of the last line to take in the file.
    **/
  unsigned int getLastLineIndex()const;
  /**
    * @brief The index of the first imported line. This index change if user use the first line as column names.
    * The first imported line is the firstLineIndex but with the
    * By example if user want to import all lines but use the first line as column names this funnction will return 1 not 0.
    **/
  unsigned int getFirstImportedLineIndex()const;

  /**
   * Empty the properties list.
   */
  void clearPropertiesTypeList();
  /**
   * Add a property to the current property list.
   */
  void addPropertyToPropertyList(const std::string& propertyName, bool isEditable, const std::string& propertyType=std::string(""));

  /**
   * @brief Creates a property configuration widget.
   *
   * @param propertyNumber The property number.
   * @param propertyName The name of the property.
   * @param propertyNameIsEditable Whether the property's name is editable.
   * @param propertyType The type of the property.
   * @param parent This widget's parent.
   * @return :PropertyConfigurationWidget*
   **/
  virtual PropertyConfigurationWidget *createPropertyConfigurationWidget(unsigned int propertyNumber,
      const QString& propertyName, bool propertyNameIsEditable, const std::string& propertyType, QWidget* parent);

  /**
    * @brief Compute the name of the column. Return the first token fo the column if the first lline is used as header r Column_x xhere x is the column index.
    **/
  QString genrateColumnName(unsigned int col)const;
  /**
    * @brief Compute the column data type. Take in account the first row only if it is not used as column label
    **/
  std::string getColumnType(unsigned int col)const;

  std::vector<PropertyConfigurationWidget*> propertyWidgets;

protected slots:

  void filterPreviewLineNumber(bool filter);
  void previewLineNumberChanged(int value);

  void fromLineValueChanged(int value);
  void toLineValueChanged(int value);

  void updateTableHeaders();

  void useFirstLineAsHeaderUpdated();
  void propertyNameChanged(QString propertyName);
  void propertyStateChanged(bool activated);

signals:
  void fileInfoChanged();

private:

  /**
    * @brief Try to guess the property datatype in function of the type of the previous tokens and the type of the current token.
    **/
  std::string guessPropertyDataType(const std::string data,const std::string previousType)const;

  /**
    * @brief Return the type of the column in function of the old and new type.
    **/
  std::string combinePropertyDataType(const std::string previousType,const std::string newType)const;
  /**
    * @brief Try to guess the type of the data. Can recognize int, double, boolean or string. If the type is other return string.
    * @return The property typename of the type
    **/
  std::string guessDataType(const std::string data)const;

  void columnSizeChanged(unsigned int i);

  //The data type of the header
  std::vector<std::string> columnHeaderType;
  //The data type of the rest of the column;
  std::vector<std::string> columnType;

  Ui::CSVImportConifgurationWidget *ui;
  PropertyNameValidator* validator;
  unsigned int maxLineNumber;
  tlp::CSVParser* parser;
};

}
#endif // CSVIMPORTCONFIGURATIONWIDGET_H
///@endcond