summaryrefslogtreecommitdiff
path: root/tools/d2c/coder.h
blob: 34544c2e11783254fa1c83544da2ce2a3060305d (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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

/* Chrysalide - Outil d'analyse de fichiers binaires
 * coder.h - prototypes pour la lecture automatisée des spécifications d'architecture
 *
 * Copyright (C) 2014-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 Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _TOOLS_D2C_CODER_H
#define _TOOLS_D2C_CODER_H


#include <stdbool.h>


#include "encoding.h"
#include "pproc.h"
#include "desc/manager.h"
#include "id/manager.h"



/* Suivi des constructions */
typedef struct _rented_coder rented_coder;



/* -------------------------- CONSTRUCTION SELON COMMANDES -------------------------- */


/* Débute la définition d'une fonction de désassemblage. */
rented_coder *create_coder(pre_processor *);

/* Supprime le codeur de la mémoire. */
void delete_coder(rented_coder *);

/* Détermine si les propriétés de base d'un codeur sont là. */
bool do_basic_checks_with_coder(const rented_coder *);

/* Indique le fichier de définition considéré en entrée. */
const char *get_coder_input_file(const rented_coder *);

/* Spécifie le fichier de définition à prendre en entrée. */
void set_coder_input_file(rented_coder *, const char *);

/* Spécifie le type de format à prendre en compte (E/S). */
//void set_coder_input_type(rented_coder *, InputOutputType);

/* Détermine l'architecture visée par les traitements. */
void set_coder_arch(rented_coder *, const char *);

/* Définit la base des protections des fichiers d'en-tête. */
void set_coder_header_base(rented_coder *, const char *);

/* Définit le préfixe pour les opérandes chargées par format. */
void set_coder_const_prefix(rented_coder *, const char *);



/* ----------------------------- INFORMATIONS GENERALES ----------------------------- */


/* Enregistre les contours d'une instruction d'assemblage. */
void save_notes_for_coder(rented_coder *, char *, char *, char, const char *);

/* Fournit la désignation nominale d'une instruction. */
char *get_coder_nominal_name(const rented_coder *);

/* Fournit la désignation complète d'une instruction. */
char *get_coder_code_name(const rented_coder *);

/* Fournit le gestionnaire des définitions d'identifiant. */
instr_id *get_coder_instruction_id(const rented_coder *);

/* Fournit le gestionnaire de description d'identifiant. */
instr_desc *get_coder_instruction_desc(const rented_coder *);



/* --------------------------- REPRESENTATION D'ENCODAGES --------------------------- */


/* Fournit un lien vers les spécifications courantes. */
encoding_spec *get_current_encoding_spec(const rented_coder *);

/* Enregistre une définition supplémentaire. */
void push_encoding_spec(rented_coder *, char *, unsigned int);

/* Marque une instruction comme non utilisée. */
void mark_coder_as_useless(rented_coder *coder);



/* --------------------------- GENERATIONS DE CODE SOURCE --------------------------- */


/* Type d'entrée/sortie attendues */
typedef enum _InputOutputType
{
    IOT_UNDEFINED,                          /* Type non défini             */
    IOT_RAW,                                /* Lecture de contenu brut     */
    IOT_FORMAT                              /* Définition d'opérandes      */

} InputOutputType;

/* Regroupement des informations utiles à la génération */
typedef struct _output_info
{
    const char *directory;                  /* Répertoire de destination   */
    InputOutputType type;                   /* Type des définitions (E/S)  */
    const char *arch;                       /* Architecture à traiter      */
    const char *arch_cn;                    /* Nom de code de l'archi.     */
    const char *guard;                      /* Portion de macro globale    */

    const char *fmt_prefix;                 /* Préfixe pour les opérandes  */

    const char *id_prefix;                  /* Préfixe pour les constantes */
    int id_len;                             /* Largeur des identifiants    */

} output_info;


/* Génère ou complète un fichier contenant le code C principal. */
bool output_coder_body(const rented_coder *, const output_info *);

/* Finalise le contenu utile du fichier des instructions. */
bool fini_coder_opcodes_file(const char *, const output_info *);

/* Génère ou complète un fichier constituant les identifiants. */
bool output_coder_identifier(const rented_coder *, const output_info *);

/* Finalise le contenu utile du fichier des identifiants. */
bool fini_coder_identifiers_file(const char *, const output_info *);

/* Génère ou complète un fichier créant les sous-identifiants. */
bool output_coder_sub_identifier(const rented_coder *, const output_info *);

/* Finalise le contenu utile du fichier des sous-identifiants. */
bool fini_coder_sub_identifiers_file(const char *, const output_info *);

/* Génère ou complète un fichier constituant les mots clefs. */
bool output_coder_keyword(const rented_coder *, const output_info *);

/* Finalise le contenu utile du fichier des mots clefs. */
bool fini_coder_keywords_file(const char *, const output_info *);

/* Génère ou complète un fichier constituant les décrochages. */
bool output_coder_hooks(const rented_coder *, const output_info *);

/* Finalise le contenu utile du fichier des décrochages. */
bool fini_coder_hooks_file(const char *, const output_info *);

/* Génère ou complète un fichier constituant les descriptions. */
bool output_coder_description(const rented_coder *, const output_info *);

/* Finalise le contenu utile du fichier des descriptions. */
bool fini_coder_descriptions_file(const char *, const output_info *);



#endif  /* _TOOLS_D2C_CODER_H */