src/encodings.h

   1 /*
   2  *      encodings.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22
  23 /**
  24  *  @file encodings.h
  25  *  Encoding conversion and Byte Order Mark (BOM) handling.
  26  **/
  27
  28 /*
  29  * Modified by the gedit Team, 2002. See the gedit AUTHORS file for a
  30  * list of people on the gedit Team.
  31  * See the gedit ChangeLog files for a list of changes.
  32  */
  33
  34  /* Stolen from anjuta */
  35
  36 #ifndef GEANY_ENCODINGS_H
  37 #define GEANY_ENCODINGS_H 1
  38
  39 #include "gtkcompat.h"
  40
  41 G_BEGIN_DECLS
  42
  43 typedef enum
  44 {
  45         NONE = 0,
  46         WESTEUROPEAN,
  47         EASTEUROPEAN,
  48         EASTASIAN,
  49         ASIAN,
  50         MIDDLEEASTERN,
  51         UNICODE,
  52
  53         GEANY_ENCODING_GROUPS_MAX
  54 } GeanyEncodingGroup;
  55
  56
  57 /** Structure to represent an encoding to be used in Geany. */
  58 typedef struct
  59 {
  60         /** The index of the encoding, must be one of GeanyEncodingIndex. */
  61         gint                             idx;
  62         /** Internally used member for grouping */
  63         gint                             order;
  64         /** Internally used member for grouping */
  65         GeanyEncodingGroup   group;
  66         /** String representation of the encoding, e.g. "ISO-8859-3" */
  67         const gchar                     *charset;
  68         /** Translatable and descriptive name of the encoding, e.g. "South European" */
  69         const gchar                     *name;
  70 } GeanyEncoding;
  71
  72
  73 const GeanyEncoding* encodings_get_from_charset(const gchar *charset);
  74 const GeanyEncoding* encodings_get_from_index(gint idx);
  75
  76 gchar* encodings_to_string(const GeanyEncoding* enc);
  77 const gchar* encodings_get_charset(const GeanyEncoding* enc);
  78 const gchar* encodings_get_charset_from_index(gint idx);
  79
  80 void encodings_select_radio_item(const gchar *charset);
  81
  82 void encodings_init(void);
  83 void encodings_finalize(void);
  84
  85 GtkTreeStore *encodings_encoding_store_new(gboolean has_detect);
  86
  87 gint encodings_encoding_store_get_encoding(GtkTreeStore *store, GtkTreeIter *iter);
  88
  89 gboolean encodings_encoding_store_get_iter(GtkTreeStore *store, GtkTreeIter *iter, gint enc);
  90
  91 void encodings_encoding_store_cell_data_func(GtkCellLayout *cell_layout, GtkCellRenderer *cell,
  92                 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer data);
  93
  94 gchar *encodings_convert_to_utf8(const gchar *buffer, gssize size, gchar **used_encoding);
  95
  96 /* Converts a string from the given charset to UTF-8.
  97  * If fast is set, no further checks are performed. */
  98 gchar *encodings_convert_to_utf8_from_charset(const gchar *buffer, gssize size,
  99                                                                                           const gchar *charset, gboolean fast);
 100
 101 gboolean encodings_is_unicode_charset(const gchar *string);
 102
 103 gboolean encodings_convert_to_utf8_auto(gchar **buf, gsize *size, const gchar *forced_enc,
 104                 gchar **used_encoding, gboolean *has_bom, gboolean *partial);
 105
 106 /*
 107  * The original versions of the following tables are taken from profterm
 108  *
 109  * Copyright (C) 2002 Red Hat, Inc.
 110  */
 111
 112 /**
 113  * @enum GeanyEncodingIndex
 114  * List of known and supported encodings.
 115  **/
 116 typedef enum
 117 {
 118         GEANY_ENCODING_ISO_8859_1,
 119         GEANY_ENCODING_ISO_8859_2,
 120         GEANY_ENCODING_ISO_8859_3,
 121         GEANY_ENCODING_ISO_8859_4,
 122         GEANY_ENCODING_ISO_8859_5,
 123         GEANY_ENCODING_ISO_8859_6,
 124         GEANY_ENCODING_ISO_8859_7,
 125         GEANY_ENCODING_ISO_8859_8,
 126         GEANY_ENCODING_ISO_8859_8_I,
 127         GEANY_ENCODING_ISO_8859_9,
 128         GEANY_ENCODING_ISO_8859_10,
 129         GEANY_ENCODING_ISO_8859_13,
 130         GEANY_ENCODING_ISO_8859_14,
 131         GEANY_ENCODING_ISO_8859_15,
 132         GEANY_ENCODING_ISO_8859_16,
 133
 134         GEANY_ENCODING_UTF_7,
 135         GEANY_ENCODING_UTF_8,
 136         GEANY_ENCODING_UTF_16LE,
 137         GEANY_ENCODING_UTF_16BE,
 138         GEANY_ENCODING_UCS_2LE,
 139         GEANY_ENCODING_UCS_2BE,
 140         GEANY_ENCODING_UTF_32LE,
 141         GEANY_ENCODING_UTF_32BE,
 142
 143         GEANY_ENCODING_ARMSCII_8,
 144         GEANY_ENCODING_BIG5,
 145         GEANY_ENCODING_BIG5_HKSCS,
 146         GEANY_ENCODING_CP_866,
 147
 148         GEANY_ENCODING_EUC_JP,
 149         GEANY_ENCODING_EUC_KR,
 150         GEANY_ENCODING_EUC_TW,
 151
 152         GEANY_ENCODING_GB18030,
 153         GEANY_ENCODING_GB2312,
 154         GEANY_ENCODING_GBK,
 155         GEANY_ENCODING_GEOSTD8,
 156         GEANY_ENCODING_HZ,
 157
 158         GEANY_ENCODING_IBM_850,
 159         GEANY_ENCODING_IBM_852,
 160         GEANY_ENCODING_IBM_855,
 161         GEANY_ENCODING_IBM_857,
 162         GEANY_ENCODING_IBM_862,
 163         GEANY_ENCODING_IBM_864,
 164
 165         GEANY_ENCODING_ISO_2022_JP,
 166         GEANY_ENCODING_ISO_2022_KR,
 167         GEANY_ENCODING_ISO_IR_111,
 168         GEANY_ENCODING_JOHAB,
 169         GEANY_ENCODING_KOI8_R,
 170         GEANY_ENCODING_KOI8_U,
 171
 172         GEANY_ENCODING_SHIFT_JIS,
 173         GEANY_ENCODING_TCVN,
 174         GEANY_ENCODING_TIS_620,
 175         GEANY_ENCODING_UHC,
 176         GEANY_ENCODING_VISCII,
 177
 178         GEANY_ENCODING_WINDOWS_1250,
 179         GEANY_ENCODING_WINDOWS_1251,
 180         GEANY_ENCODING_WINDOWS_1252,
 181         GEANY_ENCODING_WINDOWS_1253,
 182         GEANY_ENCODING_WINDOWS_1254,
 183         GEANY_ENCODING_WINDOWS_1255,
 184         GEANY_ENCODING_WINDOWS_1256,
 185         GEANY_ENCODING_WINDOWS_1257,
 186         GEANY_ENCODING_WINDOWS_1258,
 187
 188         GEANY_ENCODING_NONE,
 189         GEANY_ENCODING_CP_932,
 190
 191         GEANY_ENCODINGS_MAX
 192 } GeanyEncodingIndex;
 193
 194
 195 extern GeanyEncoding encodings[GEANY_ENCODINGS_MAX];
 196
 197
 198 GeanyEncodingIndex encodings_scan_unicode_bom(const gchar *string, gsize len, guint *bom_len);
 199
 200 GeanyEncodingIndex encodings_get_idx_from_charset(const gchar *charset);
 201
 202 G_END_DECLS
 203
 204 #endif /* GEANY_ENCODINGS_H */