summaryrefslogtreecommitdiff
path: root/src/glibext/linesegment.h
blob: a0b8e91e9867971f64e581f78510e969a793f9fd (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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

/* Chrysalide - Outil d'analyse de fichiers binaires
 * linesegment.h - prototypes pour la concentration d'un fragment de caractères aux propriétés communes
 *
 * Copyright (C) 2016-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 _GLIBEXT_LINESEGMENT_H
#define _GLIBEXT_LINESEGMENT_H


#include <glib-object.h>
#include <stdbool.h>
#include <gdk/gdk.h>
#include <pango/pango.h>



/* Liste identifiant un ensemble de segments */
typedef struct _segcnt_list segcnt_list;



/* ------------------------ NATURE POUR UN FRAGMENT DE TEXTE ------------------------ */


/* Procède à l'initialisation des paramètres de rendu de texte. */
bool load_segment_rendering_parameters(void);



/* ----------------------- ISOLATION DE CONTENUS PARTAGEABLES ----------------------- */


/* Fragment de caractères aux propriétés potentiellement partagées */
typedef struct _line_segment line_segment;


/* Initialise la table mémorisant les contenus pour segments. */
bool init_segment_content_hash_table(void);

/* Organise la sortie de la table des contenus pour segments. */
void exit_segment_content_hash_table(void);



/* -------------------- NATURE DE BASE POUR UN FRAGMENT DE TEXTE -------------------- */


/* Types de partie de rendu */
typedef enum _RenderingTagType
{
    RTT_NONE,                               /* Espace ou tabulation        */

    RTT_RAW,                                /* Contenu brut                */
    RTT_RAW_NULL,                           /* Contenu brut et nul         */
    RTT_PRINTABLE,                          /* Caractère imprimable        */
    RTT_NOT_PRINTABLE,                      /* Caractère non imprimable    */

    RTT_COMMENT,                            /* Commentaire                 */
    RTT_INDICATION,                         /* Aide à la lecture           */

    RTT_PHYS_ADDR_PAD,                      /* Position physique (début)   */
    RTT_PHYS_ADDR,                          /* Position physique           */
    RTT_VIRT_ADDR_PAD,                      /* Adresse virtuelle (début)   */
    RTT_VIRT_ADDR,                          /* Adresse virtuelle           */
    RTT_RAW_CODE,                           /* Code binaire brut           */
    RTT_RAW_CODE_NULL,                      /* Code binaire brut et nul    */

    RTT_LABEL,                              /* Etiquette sur une adresse   */

    RTT_INSTRUCTION,                        /* Code binaire brut           */

    RTT_IMMEDIATE,                          /* Valeur immédiate            */

    RTT_REGISTER,                           /* Registre                    */

    RTT_PUNCT,                              /* Signes de ponctuation       */
    RTT_HOOK,                               /* Crochets '[' et ']'         */
    RTT_SIGNS,                              /* Signes '+', '-' et '*'      */
    RTT_LTGT,                               /* Caractères '<' et '>'       */

    RTT_SECTION,                            /* Identifiant de section      */
    RTT_SEGMENT,                            /* Indication de segment       */
    RTT_STRING,                             /* Chaîne de caractères avec " */

    RTT_VAR_NAME,                           /* Nom de variable             */

    RTT_KEY_WORD,                           /* Mot clef de langage         */

    RTT_ERROR,                              /* Erreur "interne"            */

    RTT_COUNT

} RenderingTagType;


/* Crée un nouveau fragment de texte avec des propriétés. */
line_segment *get_new_line_segment(RenderingTagType, const char *, size_t);

/* Retire une utilisation à un fragment de texte. */
void release_line_segment(line_segment *);

/* Indique le type de rendu associé à un segment de ligne. */
RenderingTagType get_line_segment_type(const line_segment *);

/* Fournit le texte brut conservé dans le segment. */
char *get_line_segment_text(const line_segment *, bool);

/* Fournit la quantité de pixels requise pour l'impression. */
gint get_line_segment_width(const line_segment *);

/* Fournit la position idéale pour un marqueur. */
gint get_caret_position_from_line_segment(const line_segment *, gint);

/* Déplace le curseur au sein d'un segment de tampon. */
bool move_caret_on_line_segment(const line_segment *, gint *, bool, GdkScrollDirection);

/* Imprime le fragment de texte représenté. */
void draw_line_segment(const line_segment *, cairo_t *, gint *, gint, const segcnt_list *);

/* Types d'exportation */
typedef enum _BufferExportType
{
    BET_TEXT,                               /* Exportation en texte brut   */
    BET_HTML,                               /* Exportation en HTML         */

    BET_COUNT

} BufferExportType;

/* Elements sur lesquels une exportation peut s'appuyer */
typedef struct _buffer_export_context
{
    union
    {
        int fd;                             /* Flux ouvert en écriture     */

    };

    union
    {
        /* BET_TEXT */
        const char *sep;                    /* Séparation entre colonnes   */

        /* BET_HTML */
        struct
        {
            const char *font_name;          /* Police d'impression         */
            const char *bg_color;           /* Fond du tableau HTML        */

        };

    };

} buffer_export_context;

/* Exporte tous les styles utilisés par des segments. */
void export_line_segment_style(buffer_export_context *, BufferExportType);

/* Exporte le fragment de texte représenté. */
void export_line_segment(const line_segment *, buffer_export_context *, BufferExportType);



/* -------------------- GESTION OPTIMALE D'UNE LISTE DE CONTENUS -------------------- */


/* Initilise une liste de contenus de segments. */
segcnt_list *init_segment_content_list(void);

/* Libère la mémoire occupée par une liste de contenus. */
void exit_segment_content_list(segcnt_list *);

/* Vide, si besoin est, une liste de contenus de segments. */
bool reset_segment_content_list(segcnt_list *);

/* Marque le contenu d'un segment comme remarquable. */
bool add_segment_content_to_selection_list(segcnt_list *, const line_segment *);



#endif  /* _GLIBEXT_LINESEGMENT_H */