gcu/document.h

Go to the documentation of this file.

// -*- C++ -*-

/*
 * Gnome Chemistry Utils
 * gcu/document.h
 *
 * Copyright (C) 2004-2011 Jean Bréfort <jean.brefort@normalesup.org>
 *
 * 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 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 GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */


#ifndef GCU_DOCUMENT_H
#define GCU_DOCUMENT_H

#include <gcu/object.h>
#include <gcu/dialog-owner.h>
#include <gcu/macros.h>
#include <gcu/loader-error.h>
#include <string>
#include <set>

namespace gcu
{

class Application;
class Dialog;
class Molecule;
class Residue;
class Window;

typedef enum {
        ActionException,
        ActionDelete,
        ActionIgnore
} Action;

class Document: public Object, virtual public DialogOwner
{
friend class Application;
friend class Object;
friend class Dialog;

private:
class PendingTarget
{
public:
        Object *parent;
        Object *owner;
        Object **target;
        Action action;
};

public:
        Document (Application *App = NULL);
        virtual ~Document ();

public:

        std::string& GetTranslatedId (const char* id);

        void EraseTranslationId (const char* Id) {m_TranslationTable.erase (Id);}

        void EmptyTranslationTable() {m_TranslationTable.clear();}

        virtual void SetTitle (std::string& title) {m_Title = title;}
        virtual void SetTitle (char const *title) {m_Title = title;}
        std::string &GetTitle () {return m_Title;}

        void NotifyDirty (Object* pObject) {m_DirtyObjects.insert (pObject);}
        virtual void Save () const {;}
        virtual Residue *CreateResidue (char const *name, char const *symbol, Molecule *molecule);
        virtual Residue const *GetResidue (char const *symbol, bool *ambiguous = NULL);
        virtual GtkWindow *GetGtkWindow () {return NULL;}

        bool SetTarget (char const *id, Object **target, Object *parent, Object *owner = NULL, Action action = ActionException) throw (std::runtime_error);

        virtual bool Loaded () throw (LoaderError);
        std::string Name ();

        void ObjectLoaded (Object *obj);

        std::set < Object * > GetNewObjects () {return m_NewObjects;}

        virtual Window *GetWindow () {return NULL;}

private:

        char* GetNewId (char const *id, bool Cache = true);

private:
        std::map <std::string, std::string> m_TranslationTable;//used when Ids translations are necessary (on pasting...)
        std::map <std::string, std::list <PendingTarget> > m_PendingTable;//used to set pointers to objects when loading does not occur in the ideal order
        std::set<Object*> m_NewObjects;

protected:
        std::string m_Title;

        std::set<Object*> m_DirtyObjects;

GCU_PROT_POINTER_PROP (Application, App)
GCU_PROT_PROP (bool, Empty);
GCU_PROP (double, Scale);
};


}
#endif  //GCU_DOCUMENT_H