i18n: New functions for truncating strings in an arbitrary encoding.

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

diff --git a/src/libpspp/i18n.h b/src/libpspp/i18n.h
index e2663a022094b65e5fc5f2aa6e2d303508c2a83b..55f747b3dcd9cddb654ffd474e2b7ef67fef39bb 100644 (file)
--- a/src/libpspp/i18n.h
+++ b/src/libpspp/i18n.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2006 Free Software Foundation, Inc.
+   Copyright (C) 2006, 2010, 2011 Free Software Foundation, Inc.
 
    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
@@ -18,44 +18,47 @@
 #define I18N_H
 
 #include <stdbool.h>
+#include <unistr.h>
 
 void  i18n_done (void);
 void  i18n_init (void);
 
 #define UTF8 "UTF-8"
 
-struct pool;
-
-
-/* 
-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 '?'.
+/* The encoding of literal strings in PSPP source code, as seen at execution
+   time.  In fact this is likely to be some extended ASCII encoding, such as
+   UTF-8 or ISO-8859-1, but ASCII is adequate for our purposes. */
+#define C_ENCODING "ASCII"
 
-LENGTH should be the length of the string or -1, if null terminated.
+struct pool;
 
-The returned string will be allocated on POOL.
+char recode_byte (const char *to, const char *from, char);
 
-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 (const char *to, const char *from,
+                     const char *text, int len);
 char *recode_string_pool (const char *to, const char *from,
-                         const char *text, int length, struct pool *pool);
+                         const char *text, int length, struct pool *);
+struct substring recode_substring_pool (const char *to, const char *from,
+                                        struct substring text, struct pool *);
 
+size_t recode_string_len (const char *to, const char *from,
+                          const char *text, int len);
 
+char *utf8_encoding_trunc (const char *, const char *encoding,
+                           size_t max_len);
+size_t utf8_encoding_trunc_len (const char *, const char *encoding,
+                                size_t max_len);
 
-/* 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);
+char *utf8_encoding_concat (const char *head, const char *tail,
+                            const char *encoding, size_t max_len);
+size_t utf8_encoding_concat_len (const char *head, const char *tail,
+                                 const char *encoding, size_t max_len);
 
+char *utf8_to_filename (const char *filename);
+char *filename_to_utf8 (const char *filename);
 
 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);
@@ -63,5 +66,6 @@ void set_default_encoding (const char *enc);
 
 bool set_encoding_from_locale (const char *loc);
 
+const char *uc_name (ucs4_t uc, char buffer[16]);
 
 #endif /* i18n.h */