Document.h

/******************************************************************************************************
 * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released      *
 * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *
 * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission.     *
 ******************************************************************************************************/
 
#ifndef DOCUMENT_H
#define DOCUMENT_H
 
#include "CoordSystemContext.h"
#include "CoordSystemIndex.h"
#include "CurvesGraphs.h"
#include "CurveStyles.h"
#include "DocumentAxesPointsRequired.h"
#include "DocumentModelAxesChecker.h"
#include "DocumentModelColorFilter.h"
#include "DocumentModelCoords.h"
#include "DocumentModelDigitizeCurve.h"
#include "DocumentModelExportFormat.h"
#include "DocumentModelGeneral.h"
#include "DocumentModelGridRemoval.h"
#include "DocumentModelPointMatch.h"
#include "DocumentModelSegments.h"
#include "PointStyle.h"
#include <QList>
#include <QPixmap>
#include <QString>
#include <QXmlStreamReader>
 
class CoordSystem;
class Curve;
class QByteArray;
class QFile;
class QImage;
class QTransform;
class QXmlStreamWriter;
class Transformation;
 
class Document
{
public:
  Document (const QImage &image);
 
  Document (const QString &fileName);
 
  void addCoordSystems(unsigned int numberCoordSystemToAdd);
 
  void addGraphCurveAtEnd (const QString &curveName);
 
  void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
                                            const QPointF &posGraph,
                                            QString &identifier,
                                            double ordinal,
                                            bool isXOnly);
 
  void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
                                            const QPointF &posGraph,
                                            const QString &identifier,
                                            double ordinal,
                                            bool isXOnly);
 
  void addPointGraphWithGeneratedIdentifier (const QString &curveName,
                                             const QPointF &posScreen,
                                             QString &generatedIentifier,
                                             double ordinal);
 
  void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
                                             const QPointF &posScreen,
                                             const QString &identifier,
                                             double ordinal);
 
  void addPointsInCurvesGraphs (CurvesGraphs &curvesGraphs);
 
  void checkAddPointAxis (const QPointF &posScreen,
                          const QPointF &posGraph,
                          bool &isError,
                          QString &errorMessage,
                          bool isXOnly);
 
  void checkEditPointAxis (const QString &pointIdentifier,
                           const QPointF &posScreen,
                           const QPointF &posGraph,
                           bool &isError,
                           QString &errorMessage);
 
  const CoordSystem &coordSystem() const;
 
  unsigned int coordSystemCount() const;
 
  CoordSystemIndex coordSystemIndex() const;
 
  const Curve &curveAxes () const;
 
  const Curve *curveForCurveName (const QString &curveName) const;
 
  const CurvesGraphs &curvesGraphs () const;
 
  QStringList curvesGraphsNames () const;
 
  int curvesGraphsNumPoints (const QString &curveName) const;
 
  DocumentAxesPointsRequired documentAxesPointsRequired () const;
 
  void editPointAxis (const QPointF &posGraph,
                      const QString &identifier);
 
  bool isXOnly (const QString &pointIdentifier) const;
 
  void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
 
  void iterateThroughCurvePointsAxes (const Functor2wRet<const QString  &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
 
  void iterateThroughCurveSegments (const QString &curveName,
                                    const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
 
  void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
 
  void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
 
  bool loadCurvesFile (const QString &curvesFile);
 
  DocumentModelAxesChecker modelAxesChecker() const;
 
  DocumentModelColorFilter modelColorFilter() const;
 
  DocumentModelCoords modelCoords () const;
 
  CurveStyles modelCurveStyles() const;
 
  DocumentModelDigitizeCurve modelDigitizeCurve() const;
 
  DocumentModelExportFormat modelExport() const;
 
  DocumentModelGeneral modelGeneral() const;
 
  DocumentModelGridRemoval modelGridRemoval() const;
 
  DocumentModelPointMatch modelPointMatch() const;
 
  DocumentModelSegments modelSegments() const;
 
  void movePoint (const QString &pointIdentifier,
                  const QPointF &deltaScreen);
 
  int nextOrdinalForCurve (const QString &curveName) const;
 
  QPixmap pixmap () const;
 
  QPointF positionGraph (const QString &pointIdentifier) const;
 
  QPointF positionScreen (const QString &pointIdentifier) const;
 
  void print () const;
 
  void printStream (QString indentation,
                    QTextStream &str) const;
 
  QString reasonForUnsuccessfulRead () const;
 
  void removePointAxis (const QString &identifier);
 
  void removePointGraph (const QString &identifier);
 
  void removePointsInCurvesGraphs (CurvesGraphs &curvesGraphs);
 
  void saveXml (QXmlStreamWriter &writer) const;
 
  void setCoordSystemIndex(CoordSystemIndex coordSystemIndex);
 
  void setCurvesGraphs (const CurvesGraphs &curvesGraphs);
 
  void setCurvesGraphs (CoordSystemIndex coordSystemIndex,
                        const CurvesGraphs &curvesGraphs);
 
  void setDocumentAxesPointsRequired (DocumentAxesPointsRequired documentAxesPointsRequired);
 
  void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker);
 
  void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter);
 
  void setModelCoords (const DocumentModelCoords &modelCoords);
 
  void setModelCurveStyles(const CurveStyles &modelCurveStyles);
 
  void setModelDigitizeCurve (const DocumentModelDigitizeCurve &modelDigitizeCurve);
 
  void setModelExport(const DocumentModelExportFormat &modelExport);
 
  void setModelGeneral (const DocumentModelGeneral &modelGeneral);
 
  void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval);
 
  void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch);
 
  void setModelSegments(const DocumentModelSegments &modelSegments);
 
  bool successfulRead () const;
 
  void updatePointOrdinals (const Transformation &transformation);
 
private:
  Document ();
 
  bool bytesIndicatePreVersion6 (const QByteArray &bytes) const;
  Curve *curveForCurveName (const QString &curveName); // For use by Document only. External classes should use functors
  void generateEmptyPixmap(const QXmlStreamAttributes &attributes);
  void loadImage(QXmlStreamReader &reader);
  void loadPreVersion6 (QDataStream &str);
  void loadVersion6 (QFile *file);
  void loadVersion7 (QFile *file);
  int versionFromFile (QFile *file) const;
 
  // Metadata
  QString m_name;
  QPixmap m_pixmap;
 
  // Number of axes points used is set during creation/import
  DocumentAxesPointsRequired m_documentAxesPointsRequired;
 
  // Read variables
  bool m_successfulRead;
  QString m_reasonForUnsuccessfulRead;
 
  CoordSystemContext m_coordSystemContext;
};
 
#endif // DOCUMENT_H