gcr/document.h

Go to the documentation of this file.

// -*- C++ -*-

/*
 * Gnome Chemisty Utils
 * gcr/document.h
 *
 * Copyright (C) 2002-2012 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 GCR_DOCUMENT_H
#define GCR_DOCUMENT_H

#include <libxml/tree.h>
#include <glib.h>
#include "atom.h"
#include "bond.h"
#include "line.h"
#include "cleavage.h"
#include <gcu/chemistry.h>
#include <gcu/macros.h>
#include <gcu/gldocument.h>

namespace gcu {
class Application;
class Matrix;
class SpaceGroup;
}

namespace gcr {

class View;

enum Lattice {
        cubic=0,
        body_centered_cubic,
        face_centered_cubic,
        hexagonal,
        tetragonal,
        body_centered_tetragonal,
        orthorhombic,
        base_centered_orthorhombic,
        body_centered_orthorhombic,
        face_centered_orthorhombic,
        rhombohedral,
        monoclinic,
        base_centered_monoclinic,
        triclinic
};

class Document: public gcu::GLDocument
{
public:
        Document (gcu::Application *App);
        virtual ~Document ();

        bool Load (const std::string &filename);

        void ParseXMLTree (xmlNode* xml);
        void Update ();

        void UpdateAllViews ();

        View* GetView ();

        void Draw (gcu::Matrix const &m) const;

        virtual View* CreateNewView ();
        virtual Atom* CreateNewAtom ();
        virtual Line* CreateNewLine ();
        virtual Cleavage* CreateNewCleavage ();
        xmlDocPtr BuildXMLTree () const;
        virtual const char* GetProgramId () const;

        bool SetProperty (unsigned property, char const *value);

        std::string GetProperty (unsigned property) const;

        bool Loaded () throw (gcu::LoaderError);
        void AddChild (Object* object);
        gcu::SpaceGroup const *FindSpaceGroup ();
        void Reinit ();

        AtomList* GetAtomList () {return &AtomDef;}

        CleavageList *GetCleavageList () {return &Cleavages;}

        LineList* GetLineList () {return &LineDef;}

        void GetCell (Lattice *lattice, double *a, double *b, double *c, double *alpha, double *beta, double *gamma);

        void SetCell (Lattice lattice, double a, double b, double c, double alpha, double beta, double gamma);

        void GetSize (double* xmin, double* xmax, double* ymin, double* ymax, double* zmin, double* zmax);

        void SetSize (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax);

        void CheckAtoms ();

        void CheckCleavages ();

        void CheckLines ();

        void Define (unsigned nPage = 0);

        void AddView(View* pView);

        bool RemoveView(View* pView);

        void RemoveAllViews ();

        View *GetActiveView () {return m_pActiveView;}

        std::list <gcr::View *> *GetViews () {return &m_Views;}

        void RenameViews ();

        bool VerifySaved();

        void SetWidget (GtkWidget* widget) {m_widget = widget;}

        const gchar* GetFileName () {return m_filename;}

        void SetActiveView (View *pView) {m_pActiveView = pView;}

        void SaveAsImage (const std::string &filename, char const *type, std::map<std::string, std::string>& options);

        void SetFileName (const std::string &filename);

        void SetTitle (char const *title);
        void SetTitle (std::string& title);

        char const *GetTitle () {return m_Title.c_str ();}

        void SetAuthor (char const *author);

        void SetMail (char const *mail);

        void SetComment (char const *comment);

        void SetLabel (char const *label);

        GDate *GetCreationDate () {return &m_CreationDate;}

        GDate *GetRevisionDate () {return &m_RevisionDate;}

        char const *GetLabel () {return m_Label? m_Label: m_DefaultLabel.c_str ();}

        void OnExportVRML (const std::string &FileName) const;

        void Save () const;

protected:
        void Init ();
        virtual bool LoadNewView (xmlNodePtr node);

private:
        void Duplicate (Atom& Atom);
        void Duplicate (Line& Line);
        void Error(int num) const;

protected:
        Lattice m_lattice;
        gdouble m_a;
        gdouble m_b;
        gdouble m_c;
        gdouble m_alpha;
        gdouble m_beta;
        gdouble m_gamma;
        gdouble m_xmin;
        gdouble m_ymin;
        gdouble m_zmin;
        gdouble m_xmax;
        gdouble m_ymax;
        gdouble m_zmax;
        AtomList AtomDef;
        AtomList Atoms;
        LineList LineDef;
        LineList Lines;
        CleavageList Cleavages;
        std::list <View *> m_Views;

        GDate m_CreationDate;

        GDate m_RevisionDate;

private:
        gchar *m_filename;
        bool m_bClosing;
        GtkWidget* m_widget;
        View *m_pActiveView;
        std::string m_DefaultLabel;
        char *m_Label;

GCU_RO_PROP (std::string, NameCommon)
GCU_RO_PROP (std::string, NameSystematic)
GCU_RO_PROP (std::string, NameMineral)
GCU_RO_PROP (std::string, NameStructure)
GCU_PROP (gcu::SpaceGroup const *, SpaceGroup)
GCU_PROP (bool, AutoSpaceGroup)

GCU_PROP (bool, FixedSize);

GCU_PROP (bool, ReadOnly)

GCU_PROT_POINTER_PROP (char, Author)

GCU_PROT_POINTER_PROP (char, Mail)

GCU_PROT_POINTER_PROP (char, Comment)
};

extern gchar const *LatticeName[];

} // namespace gcr

#endif // GCR_DOCUMENT_H