Expanded comments to src/libpspp/i18n.[ch]

[pspp-builds.git] / src / libpspp / i18n.h

diff --git a/src/libpspp/i18n.h b/src/libpspp/i18n.h
index db15bad86940a955f0a0a942af548a8a7b177edb..e2663a022094b65e5fc5f2aa6e2d303508c2a83b 100644 (file)
--- a/src/libpspp/i18n.h
+++ b/src/libpspp/i18n.h
@@ -17,27 +17,51 @@
 #ifndef I18N_H
 #define I18N_H
 
-const char * get_pspp_locale (void);
-void set_pspp_locale (const char *locale);
-const char * get_pspp_charset (void);
+#include <stdbool.h>
 
 void  i18n_done (void);
 void  i18n_init (void);
 
-enum conv_id
-  {
-    CONV_PSPP_TO_UTF8,
-    CONV_SYSTEM_TO_PSPP,
-    CONV_UTF8_TO_PSPP,
-    n_CONV
-  };
+#define UTF8 "UTF-8"
 
+struct pool;
 
-char * recode_string (enum conv_id how,  const char *text, int len);
 
+/* 
+Converts the string TEXT, which should be encoded in FROM-encoding, to a
+dynamically allocated string in TO-encoding.   Any characters which cannot
+be converted will be represented by '?'.
+
+LENGTH should be the length of the string or -1, if null terminated.
+
+The returned string will be allocated on POOL.
+
+This function's behaviour differs from that of g_convert_with_fallback provided
+by GLib.  The GLib function will fail (returns NULL) if any part of the input
+string is not valid in the declared input encoding.  This function however perseveres
+even in the presence of badly encoded input.
+*/
+char *recode_string_pool (const char *to, const char *from,
+                         const char *text, int length, struct pool *pool);
+
+
+
+/* Similar to recode_string_pool, but allocates the returned value on the heap instead of 
+   in a pool.  It is the caller's responsibility to free the returned value. */
+char *recode_string (const char *to, const char *from,
+                     const char *text, int len);
+
+
+bool valid_encoding (const char *enc);
 
 /* Return the decimal separator according to the
    system locale */
 char get_system_decimal (void);
 
+const char * get_default_encoding (void);
+void set_default_encoding (const char *enc);
+
+bool set_encoding_from_locale (const char *loc);
+
+
 #endif /* i18n.h */