geany/src/encodings.h
Thomas Martitz 302b40e977 doxygen: various doxygen-related fixes in preparation for gtkdoc generation
Major changes are:

- Some types were accidentally documented, even though they couldn't be
accessed by any exported API functions. Those are removed (especially
from encodings.h).

- Some types were not documented where they should. Documentation is
added for them. Members are not necessarily documented separately if names
are self-explanatory.

- @a XXX refers to parameters of the function, it's inappropriate for
highlighting NULL (change to @c)

- As per consensus, build_info is removed from GeanyData (replaced by
pointer to avoid ABI break; added grep-able abi-todo tag so it doesn't get
forgotten)
2015-12-17 09:52:52 +01:00

141 lines
3.7 KiB
C

/*
* encodings.h - this file is part of Geany, a fast and lightweight IDE
*
* Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
* Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/**
* @file encodings.h
* Encoding conversion and Byte Order Mark (BOM) handling.
**/
/*
* Modified by the gedit Team, 2002. See the gedit AUTHORS file for a
* list of people on the gedit Team.
* See the gedit ChangeLog files for a list of changes.
*/
/* Stolen from anjuta */
#ifndef GEANY_ENCODINGS_H
#define GEANY_ENCODINGS_H 1
#include "gtkcompat.h"
G_BEGIN_DECLS
/*
* The original versions of the following tables are taken from profterm
*
* Copyright (C) 2002 Red Hat, Inc.
*/
/** List of known and supported encodings. */
typedef enum
{
GEANY_ENCODING_ISO_8859_1,
GEANY_ENCODING_ISO_8859_2,
GEANY_ENCODING_ISO_8859_3,
GEANY_ENCODING_ISO_8859_4,
GEANY_ENCODING_ISO_8859_5,
GEANY_ENCODING_ISO_8859_6,
GEANY_ENCODING_ISO_8859_7,
GEANY_ENCODING_ISO_8859_8,
GEANY_ENCODING_ISO_8859_8_I,
GEANY_ENCODING_ISO_8859_9,
GEANY_ENCODING_ISO_8859_10,
GEANY_ENCODING_ISO_8859_13,
GEANY_ENCODING_ISO_8859_14,
GEANY_ENCODING_ISO_8859_15,
GEANY_ENCODING_ISO_8859_16,
GEANY_ENCODING_UTF_7,
GEANY_ENCODING_UTF_8,
GEANY_ENCODING_UTF_16LE,
GEANY_ENCODING_UTF_16BE,
GEANY_ENCODING_UCS_2LE,
GEANY_ENCODING_UCS_2BE,
GEANY_ENCODING_UTF_32LE,
GEANY_ENCODING_UTF_32BE,
GEANY_ENCODING_ARMSCII_8,
GEANY_ENCODING_BIG5,
GEANY_ENCODING_BIG5_HKSCS,
GEANY_ENCODING_CP_866,
GEANY_ENCODING_EUC_JP,
GEANY_ENCODING_EUC_KR,
GEANY_ENCODING_EUC_TW,
GEANY_ENCODING_GB18030,
GEANY_ENCODING_GB2312,
GEANY_ENCODING_GBK,
GEANY_ENCODING_GEOSTD8,
GEANY_ENCODING_HZ,
GEANY_ENCODING_IBM_850,
GEANY_ENCODING_IBM_852,
GEANY_ENCODING_IBM_855,
GEANY_ENCODING_IBM_857,
GEANY_ENCODING_IBM_862,
GEANY_ENCODING_IBM_864,
GEANY_ENCODING_ISO_2022_JP,
GEANY_ENCODING_ISO_2022_KR,
GEANY_ENCODING_ISO_IR_111,
GEANY_ENCODING_JOHAB,
GEANY_ENCODING_KOI8_R,
GEANY_ENCODING_KOI8_U,
GEANY_ENCODING_SHIFT_JIS,
GEANY_ENCODING_TCVN,
GEANY_ENCODING_TIS_620,
GEANY_ENCODING_UHC,
GEANY_ENCODING_VISCII,
GEANY_ENCODING_WINDOWS_1250,
GEANY_ENCODING_WINDOWS_1251,
GEANY_ENCODING_WINDOWS_1252,
GEANY_ENCODING_WINDOWS_1253,
GEANY_ENCODING_WINDOWS_1254,
GEANY_ENCODING_WINDOWS_1255,
GEANY_ENCODING_WINDOWS_1256,
GEANY_ENCODING_WINDOWS_1257,
GEANY_ENCODING_WINDOWS_1258,
GEANY_ENCODING_NONE,
GEANY_ENCODING_CP_932,
GEANY_ENCODINGS_MAX
}
GeanyEncodingIndex;
gchar *encodings_convert_to_utf8(const gchar *buffer, gssize size, gchar **used_encoding);
/* Converts a string from the given charset to UTF-8.
* If fast is set, no further checks are performed. */
gchar *encodings_convert_to_utf8_from_charset(const gchar *buffer, gssize size,
const gchar *charset, gboolean fast);
const gchar* encodings_get_charset_from_index(gint idx);
G_END_DECLS
#endif /* GEANY_ENCODINGS_H */