summaryrefslogtreecommitdiff
path: root/src/analysis/project.h
blob: 7ae3c03004cd07a2b8b72d25c24de69ba9cd669a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

/* Chrysalide - Outil d'analyse de fichiers binaires
 * project.h - prototypes pour la gestion d'un groupe de fichiers binaires
 *
 * Copyright (C) 2015-2017 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide 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.
 *
 *  Chrysalide 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _ANALYSIS_PROJECT_H
#define _ANALYSIS_PROJECT_H


#include <gtk/gtk.h>


#include "binary.h"
#include "../gtkext/gtkdockstation.h"
#include "../gtkext/gtkdisplaypanel.h"


/**
 * Comme "gui/panels/panel.h" inclut "gui/editem.h", qui inclut lui même
 * ce fichier pour la mise à jour de la zone de projet, on redéfinit...
 */
typedef struct _GPanelItem GPanelItem;

/**
 * Autre boucle sans fin similaire...
 */
typedef struct _GBinaryLoader GBinaryLoader;



/* ------------------------- DEFINITION D'UN PROJET INTERNE ------------------------- */


#define G_TYPE_STUDY_PROJECT               g_study_project_get_type()
#define G_STUDY_PROJECT(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_study_project_get_type(), GStudyProject))
#define G_IS_STUDY_PROJECT(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_study_project_get_type()))
#define G_STUDY_PROJECT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass), G_TYPE_STUDY_PROJECT, GStudyProjectClass))
#define G_IS_STUDY_PROJECT_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), G_TYPE_STUDY_PROJECT))
#define G_STUDY_PROJECT_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_STUDY_PROJECT, GStudyProjectClass))


/* Projet d'étude regroupant les binaires analysés (instance) */
typedef struct _GStudyProject GStudyProject;

/* Projet d'étude regroupant les binaires analysés  (classe) */
typedef struct _GStudyProjectClass GStudyProjectClass;


/* Indique le type défini pour un projet d'étude. */
GType g_study_project_get_type(void);

/* Crée un nouveau projet vierge. */
GStudyProject *g_study_project_new(void);

/* Crée un projet à partir du contenu XML d'un fichier. */
GStudyProject *g_study_project_open(const char *);

/* Procède à l'enregistrement d'un projet donné. */
bool g_study_project_save(GStudyProject *, const char *);

/* Indique le chemin du fichier destiné à la sauvegarde. */
const char *g_study_project_get_filename(const GStudyProject *);

/* Etat d'un contenu binaire du projet */
typedef enum _ProjectContentState
{
    PCS_ROOT,                               /* Contenu principal           */
    PCS_INTERNAL,                           /* Contenu dérivé              */
    PCS_ATTACHED,                           /* Contenu complémentaire      */

    PCS_COUNT

} ProjectContentState;

/* Assure l'intégration d'un contenu binaire dans un projet. */
void g_study_project_add_binary_content(GStudyProject *, GBinContent *, ProjectContentState);

/* Recherche un contenu binaire du projet selon son empreinte. */
GBinContent *g_study_project_find_binary_content_by_hash(GStudyProject *, const char *);

/* Acquitte la fin d'un chargement différé et complet. */
void ack_loaded_binary(GBinaryLoader *, GStudyProject *);

/* Assure l'intégration d'un élément binaire dans un projet. */
void g_study_project_add_loaded_binary(GLoadedBinary *, GStudyProject *);

/* Attache un fichier donné à un projet donné. */
void g_study_project_attach_binary(GStudyProject *, GLoadedBinary *);

/* Détache un fichier donné à un projet donné. */
void g_study_project_detach_binary(GStudyProject *, GLoadedBinary *);

/* Met en place un projet à l'écran. */
void g_study_project_display(const GStudyProject *);

/* Fournit l'ensemble des binaires associés à un projet. */
GLoadedBinary **g_study_project_get_binaries(const GStudyProject *, size_t *);



/* ----------------------- VUES ET BASCULEMENT ENTRE LES VUES ----------------------- */


/* Met en place un ensemble de vues pour un binaire. */
GPanelItem *setup_new_panel_item_for_binary(GStudyProject *, GLoadedBinary *, BinaryView, GtkDisplayPanel **);

/* Fournit la station d'accueil d'un panneau d'affichage. */
GtkDockStation *get_dock_station_for_view_panel(GtkDisplayPanel *);

/* Fournit le support défilant d'un panneau d'affichage. */
GtkWidget *get_scroll_window_for_view_panel(GtkDisplayPanel *);

/* Fournit une vision alternative d'un panneau d'affichage. */
GtkDisplayPanel *get_alt_view_for_view_panel(GtkDisplayPanel *, BinaryView);



/* ------------------------- GESTION GLOBALISEE DES PROJETS ------------------------- */


/* Fournit l'adresse du projet courant. */
GStudyProject *_get_current_study_project(GStudyProject *);

#define set_current_project(prj) _get_current_study_project(prj)
#define get_current_project() _get_current_study_project(NULL)

/* Fournit le gestionnaire des projets connus. */
GtkRecentManager *get_projects_manager(void);

/* Place un projet au sommet de la pile des projets récents. */
void push_project_into_recent_list(const GStudyProject *);




#endif  /* _PROJECT_H */