//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright            : (C) 2010 by Eran Ifrah
// file name            : tabgroupmanager.h
//
// -------------------------------------------------------------------------
// A
//              _____           _      _     _ _
//             /  __ \         | |    | |   (_) |
//             | /  \/ ___   __| | ___| |    _| |_ ___
//             | |    / _ \ / _  |/ _ \ |   | | __/ _ )
//             | \__/\ (_) | (_| |  __/ |___| | ||  __/
//              \____/\___/ \__,_|\___\_____/_|\__\___|
//
//                                                  F i l e
//
//    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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////


#ifndef TABGROUP_MANAGER_H
#define TABGROUP_MANAGER_H

#include <wx/arrstr.h>
#include <wx/string.h>
#include <vector>
#include <utility>
#include "singleton.h"

	/**
	 * Each pair consists of the tabgroup name, and an array of the names of the constituent tabs
	 */
	typedef std::pair<wxString,wxArrayString> spTabGrp;
	typedef std::vector< spTabGrp > vTabGrps;

class TabgroupManager {
  	friend class Singleton<TabgroupManager>;

public:


	wxString GetTabgroupDirectory();
	vTabGrps& GetTabgroups();
	void ClearTabgroups() {
        m_tabgroups.clear();
        m_tabgroupdir.Clear();
    }

	/*!
	 * \brief Finds the spTabGrp that matches tabgroupname, returning its TabgroupItems in items
	 * \param tabgroupname
	 * \param items
	 * \return true if tabgroup was found
	 */
	bool FindTabgroup(const wxString& tabgroupname, wxArrayString& items);
	void LoadTabgroupData(const wxString& tabgroup);

	wxXmlNode* FindTabgroupItem(wxXmlDocument& doc, const wxString& filepath, const wxString& itemfilepath);
	bool DoAddItemToTabgroup(wxXmlDocument& doc, wxXmlNode* node, const wxString& filepath, const wxString& nextitemfilepath);
	/*!
	 * \brief Remove this item from the tabgroup on disc, optionally returning its data in an xml node to be stored for Cut
	 * \param doc
	 * \param filepath
	 * \param itemfilepath
	 * \return
	 */
	wxXmlNode* DoDeleteTabgroupItem(wxXmlDocument& doc, const wxString& filepath, const wxString& itemfilepath);


protected:
	TabgroupManager(){}
	~TabgroupManager();

	void LoadKnownTabgroups();
	void TransferKnownTabgroupsToTabgroupDir(const wxString& TabgrpPath); // Transitional code. Remove sometime
	void SetTabgroupDirectory();

	wxString m_tabgroupdir;
	vTabGrps m_tabgroups;
};


typedef Singleton<TabgroupManager> TabGroupsManager;

#endif // TABGROUP_MANAGER_H
