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
  38
  39 G_BEGIN_DECLS
  40
  41 typedef enum
  42 {
  43         NONE = 0,
  44         WESTEUROPEAN,
  45         EASTEUROPEAN,
  46         EASTASIAN,
  47         ASIAN,
  48         MIDDLEEASTERN,
  49         UNICODE,
  50
  51         GEANY_ENCODING_GROUPS_MAX
  52 } GeanyEncodingGroup;
  53
  54
  55 /** Structure to represent an encoding to be used in Geany. */
  56 typedef struct
  57 {
  58         /** The index of the encoding, must be one of GeanyEncodingIndex. */
  59         gint                             idx;
  60         /** Internally used member for grouping */
  61         gint                             order;
  62         /** Internally used member for grouping */
  63         GeanyEncodingGroup   group;
  64         /** String representation of the encoding, e.g. "ISO-8859-3" */
  65         const gchar                     *charset;
  66         /** Translatable and descriptive name of the encoding, e.g. "South European" */
  67         const gchar                     *name;
  68 } GeanyEncoding;
  69
  70
  71 const GeanyEncoding* encodings_get_from_charset(const gchar *charset);
  72 const GeanyEncoding* encodings_get_from_index(gint idx);
  73
  74 gchar* encodings_to_string(const GeanyEncoding* enc);
  75 const gchar* encodings_get_charset(const GeanyEncoding* enc);
  76 const gchar* encodings_get_charset_from_index(gint idx);
  77
  78 void encodings_select_radio_item(const gchar *charset);
  79
  80 void encodings_init(void);
  81 void encodings_finalize(void);
  82
  83 gchar *encodings_convert_to_utf8(const gchar *buffer, gssize size, gchar **used_encoding);
  84
  85 /* Converts a string from the given charset to UTF-8.
  86  * If fast is set, no further checks are performed. */
  87 gchar *encodings_convert_to_utf8_from_charset(const gchar *buffer, gssize size,
  88                                                                                           const gchar *charset, gboolean fast);
  89
  90 gboolean encodings_is_unicode_charset(const gchar *string);
  91
  92 gboolean encodings_convert_to_utf8_auto(gchar **buf, gsize *size, const gchar *forced_enc,
  93                 gchar **used_encoding, gboolean *has_bom, gboolean *partial);
  94
  95 /*
  96  * The original versions of the following tables are taken from profterm
  97  *
  98  * Copyright (C) 2002 Red Hat, Inc.
  99  */
 100
 101 /**
 102  * @enum GeanyEncodingIndex
 103  * List of known and supported encodings.
 104  **/
 105 typedef enum
 106 {
 107         GEANY_ENCODING_ISO_8859_1,
 108         GEANY_ENCODING_ISO_8859_2,
 109         GEANY_ENCODING_ISO_8859_3,
 110         GEANY_ENCODING_ISO_8859_4,
 111         GEANY_ENCODING_ISO_8859_5,
 112         GEANY_ENCODING_ISO_8859_6,
 113         GEANY_ENCODING_ISO_8859_7,
 114         GEANY_ENCODING_ISO_8859_8,
 115         GEANY_ENCODING_ISO_8859_8_I,
 116         GEANY_ENCODING_ISO_8859_9,
 117         GEANY_ENCODING_ISO_8859_10,
 118         GEANY_ENCODING_ISO_8859_13,
 119         GEANY_ENCODING_ISO_8859_14,
 120         GEANY_ENCODING_ISO_8859_15,
 121         GEANY_ENCODING_ISO_8859_16,
 122
 123         GEANY_ENCODING_UTF_7,
 124         GEANY_ENCODING_UTF_8,
 125         GEANY_ENCODING_UTF_16LE,
 126         GEANY_ENCODING_UTF_16BE,
 127         GEANY_ENCODING_UCS_2LE,
 128         GEANY_ENCODING_UCS_2BE,
 129         GEANY_ENCODING_UTF_32LE,
 130         GEANY_ENCODING_UTF_32BE,
 131
 132         GEANY_ENCODING_ARMSCII_8,
 133         GEANY_ENCODING_BIG5,
 134         GEANY_ENCODING_BIG5_HKSCS,
 135         GEANY_ENCODING_CP_866,
 136
 137         GEANY_ENCODING_EUC_JP,
 138         GEANY_ENCODING_EUC_KR,
 139         GEANY_ENCODING_EUC_TW,
 140
 141         GEANY_ENCODING_GB18030,
 142         GEANY_ENCODING_GB2312,
 143         GEANY_ENCODING_GBK,
 144         GEANY_ENCODING_GEOSTD8,
 145         GEANY_ENCODING_HZ,
 146
 147         GEANY_ENCODING_IBM_850,
 148         GEANY_ENCODING_IBM_852,
 149         GEANY_ENCODING_IBM_855,
 150         GEANY_ENCODING_IBM_857,
 151         GEANY_ENCODING_IBM_862,
 152         GEANY_ENCODING_IBM_864,
 153
 154         GEANY_ENCODING_ISO_2022_JP,
 155         GEANY_ENCODING_ISO_2022_KR,
 156         GEANY_ENCODING_ISO_IR_111,
 157         GEANY_ENCODING_JOHAB,
 158         GEANY_ENCODING_KOI8_R,
 159         GEANY_ENCODING_KOI8_U,
 160
 161         GEANY_ENCODING_SHIFT_JIS,
 162         GEANY_ENCODING_TCVN,
 163         GEANY_ENCODING_TIS_620,
 164         GEANY_ENCODING_UHC,
 165         GEANY_ENCODING_VISCII,
 166
 167         GEANY_ENCODING_WINDOWS_1250,
 168         GEANY_ENCODING_WINDOWS_1251,
 169         GEANY_ENCODING_WINDOWS_1252,
 170         GEANY_ENCODING_WINDOWS_1253,
 171         GEANY_ENCODING_WINDOWS_1254,
 172         GEANY_ENCODING_WINDOWS_1255,
 173         GEANY_ENCODING_WINDOWS_1256,
 174         GEANY_ENCODING_WINDOWS_1257,
 175         GEANY_ENCODING_WINDOWS_1258,
 176
 177         GEANY_ENCODING_NONE,
 178         GEANY_ENCODING_CP_932,
 179
 180         GEANY_ENCODINGS_MAX
 181 } GeanyEncodingIndex;
 182
 183
 184 extern GeanyEncoding encodings[GEANY_ENCODINGS_MAX];
 185
 186
 187 GeanyEncodingIndex encodings_scan_unicode_bom(const gchar *string, gsize len, guint *bom_len);
 188
 189 GeanyEncodingIndex encodings_get_idx_from_charset(const gchar *charset);
 190
 191 G_END_DECLS
 192
 193 #endif