/****************************************************************************
* VCGLib                                                            o o     *
* Visual and Computer Graphics Library                            o     o   *
*                                                                _   O  _   *
* Copyright(C) 2004                                                \/)\/    *
* Visual Computing Lab                                            /\/|      *
* ISTI - Italian National Research Council                           |      *
*                                                                    \      *
* All rights reserved.                                                      *
*                                                                           *
* This program is free software; you can redistribute it and/or modify      *   
* it under the terms of the GNU General Public License as published by      *
* the Free Software Foundation; either version 2 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 (http://www.gnu.org/licenses/gpl.txt)          *
* for more details.                                                         *
*                                                                           *
****************************************************************************/
/****************************************************************************
  History

$Log: not supported by cvs2svn $
Revision 1.5  2005/02/19 16:22:45  ponchio
Minor changes (visited and Cell)

Revision 1.4  2005/02/17 16:40:35  ponchio
Optimized BuildLevels.

Revision 1.3  2005/02/08 12:43:03  ponchio
Added copyright


****************************************************************************/

#ifndef NXS_HISTORY_H
#define NXS_HISTORY_H

#include <vector>
#include <map>

//TODO fix a bit better the quick <-> updates duality

namespace nxs {
  
  class Nexus;
  class History {
  public:

    enum Mode { QUICK = 1, UPDATES = 2 };
    
    struct Update {
      std::vector<unsigned int> erased;
      std::vector<unsigned int> created;
    };

    //    struct Cell {
    //      unsigned int patch;
    //      float error;
    //    };

    struct Node;

    struct Link {
      Node *node;

      //TODO move to frag_begin frag_end (instead of frag_size)
      //and test speed... before so maybe also for node 
      typedef unsigned int iterator;
      iterator begin() { return frag_begin; }
      iterator end() { return frag_begin + frag_size; }
      unsigned int size() { return frag_size; }

      unsigned int frag_begin;
      unsigned int frag_size;
    };

    struct Node {
      typedef Link *iterator;
    
      iterator in_begin() { return in_link_begin; }
      iterator in_end() { return in_link_begin + in_link_size; }
      unsigned int size() { return in_link_size; }

      iterator out_begin() { return out_link_begin; }
      iterator out_end() { return out_link_begin + out_link_size; }
      unsigned int out_size() { return out_link_size; }

      Link *in_link_begin;
      unsigned int in_link_size;
      Link *out_link_begin;
      unsigned int out_link_size;
    };

    Node *nodes;
    Link *in_links;
    Link *out_links;
    //TODO this list is really not necessary if we order our cells
    //    unsigned int *frags;

    std::vector<Update> updates;

    History(): nodes(NULL), in_links(NULL), out_links(NULL),// frags(NULL), 
      buffer(NULL) {}
    ~History();
   
    Node *Root() { return &nodes[0]; }

    void Clear();
    void ClearQuick();
    void ClearUpdates();
    //Owns memory afterwards.. do not free mem.
    bool Load(unsigned int size, char *mem);
    bool LoadQuick(unsigned int size, char *mem);
    bool LoadUpdates(unsigned int size, char *mem);

    //after these call history is invalid! and memory returned must be freed...
    char *Save(unsigned int &size); //autodetect
    char *SaveQuick(unsigned int &size);
    char *SaveUpdates(unsigned int &size);

    bool QuickToUpdates();
    bool UpdatesToQuick(Nexus &nexus);
    bool IsQuick() { return buffer != NULL; }

    void BuildLevels(std::vector<int> &levels);

    int &quick() { return ((int *)buffer)[0]; }
    int &n_nodes() { return ((int *)buffer)[1]; }
    int &n_in_links() { return ((int *)buffer)[2]; }
    int &n_out_links() { return ((int *)buffer)[3]; }
    //    int &n_frags() { return ((int *)buffer)[4]; }

    typedef Node *iterator;
    iterator begin() { return nodes; }
    iterator end() { return nodes + n_nodes(); }
  protected:
    unsigned int size;
    char *buffer;

    bool LoadPointers();
  };
  
}
#endif