pointlayout.h

/* 
 * Copyright (C) 2006-2013  Music Technology Group - Universitat Pompeu Fabra
 *
 * This file is part of Gaia
 * 
 * Gaia is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU Affero General Public License as published by the Free 
 * Software Foundation (FSF), 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 Affero GNU General Public License
 * version 3 along with this program.  If not, see http://www.gnu.org/licenses/
 */

#ifndef GAIA_POINTLAYOUT_H
#define GAIA_POINTLAYOUT_H

#include <QSharedData>
#include <QDataStream>
#include <QString>
#include "descriptortree.h"
#include "descriptor.h"

namespace gaia2 {


typedef QMap<Enum, QString> EnumMap;
typedef QMap<QString, Enum> ReverseEnumMap;

class PointLayoutData : public QSharedData {
 public:
  QString name; // only used for debugging

  // each node is a QString, each leaf is a segment.
  // an entire region doesn't have to be stored in each node, as it can be
  // created dynamically on demand by merging all leaves children of the
  // specified node
  // contains real, label, etc... which are in fact encoded in each individual
  // segment
  DescriptorTree* tree;

  // global maps that hold the conversions enum<->string for all descriptors
  QMap<QString, EnumMap> enum2str;
  QMap<QString, ReverseEnumMap> str2enum;

  PointLayoutData();
  PointLayoutData(const PointLayoutData& rhs);
  ~PointLayoutData();
};

class PointLayout {

 public:

  PointLayout();
  PointLayout(const PointLayout& other);
  ~PointLayout();

  PointLayout copy() const;

  Region descriptorLocation(const QString& name) const;

  Region descriptorLocation(const QStringList& names) const;

  QString descriptorName(DescriptorType type, DescriptorLengthType ltype, int index) const;

  QStringList descriptorNames() const;

  QStringList descriptorNames(const Region& region) const;

  QStringList descriptorNames(const QStringList& patterns) const;

  QStringList descriptorNames(DescriptorType type, const QString& pattern) const;

  QStringList descriptorNames(DescriptorType type,
                              const QStringList& patterns = QStringList("*"),
                              bool failOnUnmatched = true) const;

  StringDescriptor enumToString(const QString& name, const EnumDescriptor& value) const;

  QString enumToString(const QString& name, const Enum& value) const;

  EnumDescriptor stringToEnum(const QString& name, const StringDescriptor& str) const;

  Enum stringToEnum(const QString& name, const QString& str) const;

  bool isEmpty() const { return _d->tree->isLeaf(); }

  bool subsetOf(const PointLayout& layout) const;

  void add(const QString& nodeName, DescriptorType type = UndefinedType,
           DescriptorLengthType ltype = VariableLength, int size = 1);

  void add(const QString& parentName, const QString& childName,
           DescriptorType type = UndefinedType,
           DescriptorLengthType ltype = VariableLength, int size = 1);


  void remove(const QString& name);

  void remove(const QStringList& names);

  void fixLength(const QString& name, int size);

  void fixLength(const QList<QPair<QString, int> >& descs);

  void enumerate(const QString& name);

  PointLayout operator&(const PointLayout& other) const;

  QStringList symmetricDifferenceWith(const PointLayout& layout) const;

  QStringList differenceWith(const PointLayout& layout) const;

  bool canMorphInto(const PointLayout& targetLayout) const;

  Point* morphPoint(const Point* point) const;

  void filter(const QStringList& select, const QStringList& exclude);

  void debug() const;

  QString toYaml() const;

  QString fullName(const QString& name) const;

  int regionSize(DescriptorType type, DescriptorLengthType ltype) const;

  Region correspondingRegion() const;

  bool operator==(const PointLayout& rhs) const;
  bool operator!=(const PointLayout& rhs) const;

  bool sameObjectAs(const PointLayout& layout) const;

  bool sameEnumMap(const PointLayout& layout, const QString& enumName) const;

  int ref() const { return _d->ref; }

  friend QDataStream& operator<<(QDataStream& out, const PointLayout& layout);
  friend QDataStream& operator>>(QDataStream& in, PointLayout& layout);

 protected:

  QExplicitlySharedDataPointer<PointLayoutData> _d;

  friend class Point; // for access to *NoUpdate methods
  friend PointLayout mergeLayouts(const PointLayout& layout1, const PointLayout& layout2);

  void addNoUpdate(const QString& parentName, const QString& childName,
                   DescriptorType type = UndefinedType,
                   DescriptorLengthType ltype = VariableLength, int size = 1);

  void addNoUpdateFromRoot(const QString& parentName, const QString& childName,
                           DescriptorType type = UndefinedType,
                           DescriptorLengthType ltype = VariableLength, int size = 1);

  void removeNoUpdate(const QString& name);

  void update() { _d->tree->updateLayout(); }

};

} // namespace gaia2

#endif // GAIA_POINTLAYOUT_H