region.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_REGION_H
#define GAIA_REGION_H

#include <QString>
#include <QList>
#include <QDataStream>
#include "gaia.h"

namespace gaia2 {

class Point;
class PointLayout;

enum DescriptorType {
  UndefinedType,
  RealType,
  StringType,
  EnumType
};

enum DescriptorLengthType {
  FixedLength,
  VariableLength
};

inline QString typeToString(DescriptorType type) {
  switch (type) {
  case UndefinedType: return "Undefined";
  case RealType: return "Real";
  case StringType: return "String";
  case EnumType: return "Enum";
  }
  return QString("Error in type conversion");
}

inline QString lengthTypeToString(DescriptorLengthType ltype) {
  switch (ltype) {
  case FixedLength: return "fixed-length";
  case VariableLength: return "variable-length";
  }
  return QString("Error in length type conversion");
}

class Segment {
 public:
  QString name;
  DescriptorType type;
  DescriptorLengthType ltype;
  int begin;
  int end;

  Segment() : name(""), type(UndefinedType), ltype(VariableLength), begin(-1), end(-1) {}

  Segment(QString name, DescriptorType type) :
    name(name), type(type), ltype(VariableLength),
    begin(-1), end(-1) {}

  Segment(QString name, DescriptorType type, DescriptorLengthType ltype,
          int begin, int end) :
    name(name), type(type), ltype(ltype), begin(begin), end(end) {}

  bool operator==(const Segment& rhs) const {
    return (type == rhs.type) && (begin == rhs.begin) && (ltype == rhs.ltype) &&
           (end == rhs.end);
  }

  bool operator<(const Segment& rhs) const {
    return ((this->type < rhs.type) ||
            ((this->type == rhs.type) && (this->ltype < rhs.ltype)) ||
            ((this->type == rhs.type) && (this->ltype == rhs.ltype) && (this->begin < rhs.begin)) ||
            ((this->type == rhs.type) && (this->ltype == rhs.ltype) && (this->begin == rhs.begin) && (this->end < rhs.end)));
  }

  inline int size() const {
    return end - begin;
  }

  QString toString() const;

  static Segment undefined;

  friend QDataStream& operator<<(QDataStream& out, const Segment& segment);
  friend QDataStream& operator>>(QDataStream& in, Segment& segment);
};


class Region {
 public:
  QString name;
  QList<Segment> segments;

  Region& merge(const Region& r);

  DescriptorType type() const;

  DescriptorLengthType lengthType() const;

  int index() const;

  int index(DescriptorType type, DescriptorLengthType ltype) const;

  int index(DescriptorLengthType ltype) const;

  void checkTypeOnlyFrom(DescriptorType type, const PointLayout* layout = 0) const;

  bool isTypeOnlyFrom(DescriptorType type) const;

  void checkLengthTypeOnlyFrom(DescriptorLengthType ltype, const PointLayout* layout = 0) const;

  bool isLengthTypeOnlyFrom(DescriptorLengthType type) const;

  void checkSingleDescriptor() const;

  int dimension(DescriptorType type = UndefinedType, const Point* p = 0) const;


  const Segment& segment() const;

  const Segment& segment(DescriptorType type) const;

  int size(DescriptorType type, DescriptorLengthType ltype) const;

  // isn't it better to access directly to the segments member variable?
  QVector<int> listIndices(DescriptorType type, DescriptorLengthType ltype) const;

  Region select(DescriptorType type) const;

  Region select(DescriptorType type, DescriptorLengthType ltype) const;

  QString toString() const;


  // debug purposes only
  void debug();

  void canonical();

};


} // namespace gaia2

#endif // GAIA_REGION_H