1 /*   EXTRAITS DE LA LICENCE
2 	Copyright CEA, contributeurs : Luc BILLARD et Damien
3 	CALISTE, laboratoire L_Sim, (2001-2005)
4 
5 	Adresse mèl :
6 	BILLARD, non joignable par mèl ;
7 	CALISTE, damien P caliste AT cea P fr.
8 
9 	Ce logiciel est un programme informatique servant à visualiser des
10 	structures atomiques dans un rendu pseudo-3D.
11 
12 	Ce logiciel est régi par la licence CeCILL soumise au droit français et
13 	respectant les principes de diffusion des logiciels libres. Vous pouvez
14 	utiliser, modifier et/ou redistribuer ce programme sous les conditions
15 	de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
16 	sur le site "http://www.cecill.info".
17 
18 	Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
19 	pris connaissance de la licence CeCILL, et que vous en avez accepté les
20 	termes (cf. le fichier Documentation/licence.fr.txt fourni avec ce logiciel).
21 */
22 
23 /*   LICENCE SUM UP
24 	Copyright CEA, contributors : Luc BILLARD et Damien
25 	CALISTE, laboratoire L_Sim, (2001-2005)
26 
27 	E-mail address:
28 	BILLARD, not reachable any more ;
29 	CALISTE, damien P caliste AT cea P fr.
30 
31 	This software is a computer program whose purpose is to visualize atomic
32 	configurations in 3D.
33 
34 	This software is governed by the CeCILL  license under French law and
35 	abiding by the rules of distribution of free software.  You can  use,
36 	modify and/ or redistribute the software under the terms of the CeCILL
37 	license as circulated by CEA, CNRS and INRIA at the following URL
38 	"http://www.cecill.info".
39 
40 	The fact that you are presently reading this means that you have had
41 	knowledge of the CeCILL license and that you accept its terms. You can
42 	find a copy of this licence shipped with this software at Documentation/licence.en.txt.
43 */
44 #ifndef VISU_BASIC_H
45 #define VISU_BASIC_H
46 
47 #include <glib.h>
48 #include "visu_tools.h"
49 #include "coreTools/toolPhysic.h"
50 
51 G_BEGIN_DECLS
52 
53 void visu_basic_init(void);
54 void visu_basic_initConfigFiles(GError **error);
55 
56 /* Common parse routines. */
57 gboolean visu_basic_parseConfigFiles(GError **error);
58 gboolean visu_basic_showOptionHelp(gboolean force);
59 
60 /* Export routines. */
61 int visu_basic_mainExport(void);
62 
63 /* Some resources. */
64 ToolUnits visu_basic_getPreferedUnit(void);
65 gboolean visu_basic_setPreferedUnit(ToolUnits unit);
66 
67 /**
68  * VISU_VERSION:
69  *
70  * The value of current compiled version.
71  */
72 #define VISU_VERSION       VERSION
73 /**
74  * VISU_WEB_SITE:
75  *
76  * URL where to find info on V_Sim.
77  */
78 #define VISU_WEB_SITE      "http://inac.cea.fr/L_Sim/V_Sim"
79 
80 /* Main paths. */
81 void visu_basic_setExePath(const gchar *exePath);
82 /**
83  * V_SIM_DATA_DIR:
84  *
85  * The directory where data files are stored.
86  */
87 #define V_SIM_DATA_DIR           visu_basic_getDataDir()
88 /**
89  * V_SIM_LEGAL_DIR:
90  *
91  * The directory where copyright and author files are stored.
92  */
93 #define V_SIM_LEGAL_DIR          visu_basic_getLegalDir()
94 /**
95  * V_SIM_PIXMAPS_DIR:
96  *
97  * The directory where pixmap files are stored.
98  */
99 #define V_SIM_PIXMAPS_DIR        visu_basic_getPixmapsDir()
100 /**
101  * V_SIM_ICONS_DIR:
102  *
103  * The directory where icon files are stored.
104  */
105 #define V_SIM_ICONS_DIR          visu_basic_getIconsDir()
106 /**
107  * V_SIM_LOCAL_CONF_DIR:
108  *
109  * The directory where user configuration files are stored.
110  */
111 #define V_SIM_LOCAL_CONF_DIR     visu_basic_getLocalDir()
112 /**
113  * V_SIM_OLD_LOCAL_CONF_DIR:
114  *
115  * Old value of #V_SIM_LOCAL_CONF_DIR.
116  */
117 #define V_SIM_OLD_LOCAL_CONF_DIR visu_basic_getOldLocalDir()
118 /**
119  * V_SIM_PLUGINS_DIR:
120  *
121  * The directory where plugin files are stored.
122  */
123 #define V_SIM_PLUGINS_DIR        visu_basic_getPluginsDir()
124 /**
125  * V_SIM_LOCALE_DIR:
126  *
127  * The directory where locale files are stored.
128  */
129 #define V_SIM_LOCALE_DIR         visu_basic_getLocaleDir()
130 const gchar* visu_basic_getDataDir(void);
131 const gchar* visu_basic_getLegalDir(void);
132 const gchar* visu_basic_getPixmapsDir(void);
133 const gchar* visu_basic_getIconsDir(void);
134 const gchar* visu_basic_getLocalDir(void);
135 const gchar* visu_basic_getOldLocalDir(void);
136 const gchar* visu_basic_getPluginsDir(void);
137 const gchar* visu_basic_getLocaleDir(void);
138 
139 /* Miscellaneous. */
140 GMainContext* visu_basic_getMainContext(void);
141 void visu_basic_freeAll(void);
142 
143 G_END_DECLS
144 
145 #endif
146