wsutil/unicode-utils.h

   1 /* unicode-utils.h
   2  * Unicode utility definitions
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 2006 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __UNICODEUTIL_H__
  26 #define __UNICODEUTIL_H__
  27
  28 #ifdef _WIN32
  29
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <glib.h>
  35 #include <windows.h>
  36 #include <tchar.h>
  37 #include <wchar.h>
  38
  39 /**
  40  * @file Unicode convenience routines.
  41  */
  42
  43 /** Given a UTF-8 string, convert it to UTF-16.  This is meant to be used
  44  * to convert between GTK+ 2.x (UTF-8) to Windows (UTF-16).
  45  *
  46  * @param utf8str The string to convert.  May be NULL.
  47  * @return The string converted to UTF-16.  If utf8str is NULL, returns
  48  * NULL.  The return value should NOT be freed by the caller.
  49  */
  50 wchar_t * utf_8to16(const char *utf8str);
  51
  52 /** Create a UTF-16 string (in place) according to the format string.
  53  *
  54  * @param utf16buf The buffer to return the UTF-16 string in.
  55  * @param utf16buf_len The size of the 'utf16buf' parameter
  56  * @param fmt A standard g_printf() format string
  57  */
  58 void utf_8to16_snprintf(TCHAR *utf16buf, gint utf16buf_len, const gchar* fmt, ...);
  59
  60 /** Given a UTF-16 string, convert it to UTF-8.  This is meant to be used
  61  * to convert between GTK+ 2.x (UTF-8) to Windows (UTF-16).
  62  *
  63  * @param utf16str The string to convert.  May be NULL.
  64  * @return The string converted to UTF-8.  If utf16str is NULL, returns
  65  * NULL.  The return value should NOT be freed by the caller.
  66  */
  67 gchar * utf_16to8(const wchar_t *utf16str);
  68
  69 /** Convert the program argument list from UTF-16 to UTF-8 and
  70  * store it in the supplied array. This is intended to be used
  71  * to normalize command line arguments at program startup.
  72  *
  73  * @param argc The number of arguments. You should simply pass the
  74  * first argument from main().
  75  * @param argv The argument values (vector). You should simply pass
  76  * the second argument from main().
  77  */
  78 void arg_list_utf_16to8(int argc, char *argv[]);
  79
  80
  81 #endif /* _WIN32 */
  82
  83 #endif /* __UNICODEUTIL_H__ */