/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 *  This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * Author: Moatamri Faker <faker.moatamri@sophia.inria.fr>
 */

#include "attribute-default-iterator.h"
#include "ns3/type-id.h"
#include <gtk/gtk.h>
#include <vector>

namespace ns3 {

enum
{
  COL_TYPEID = 0, COL_LASTID
};

/**
 * \ingroup configstore
 * \brief A class used in the implementation of the GtkConfigStore
 */
struct ModelTypeid
{
  /**
   * \enum node type
   * \brief Whether the node represents an attribute or TypeId
   */
  enum
  {
    // store TypeId + attribute name +defaultValue and index
    NODE_ATTRIBUTE,
    // store TypeId
    NODE_TYPEID
  } type; ///< node type
  /// TypeId name
  std::string name;
  /// TypeId default value
  std::string defaultValue;
  /// The TypeId object and if it is an attribute, it's the TypeId object of the attribute
  TypeId tid;
  /// stores the index of the attribute in list of attributes for a given TypeId
  uint32_t index;
};

/**
 * \ingroup configstore
 * \brief ModelTypeIdCreator class
 */
class ModelTypeidCreator : public AttributeDefaultIterator
{
public:
  ModelTypeidCreator ();
  /**
   * \brief This method will iterate on typeIds having default attributes and create a model
   * for them, this model will be used by the view.
   */
  void Build (GtkTreeStore *treestore);
private:
  /**
   * \brief This method will add a ModelTypeid to the GtkTreeIterator
   */
  virtual void VisitAttribute (TypeId tid, std::string name, std::string defaultValue, uint32_t index);
  /**
   * \brief Add a node for the new TypeId object
   */
  virtual void StartVisitTypeId (std::string name);
  /**
   * \brief Remove the last gtk tree iterator
   */
  virtual void EndVisitTypeId (void);
  /**
   * \brief Adds a treestore iterator to m_treestore model
   */
  void Add (ModelTypeid *node);
  /**
   * Removes the last GtkTreeIterator from m_iters
   */
  void Remove (void);
  /// this is the TreeStore model corresponding to the view
  GtkTreeStore *m_treestore;
  /// This contains a vector of iterators used to build the TreeStore
  std::vector<GtkTreeIter *> m_iters;
};
}
