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 73fa2dfe4cef1b5b30a59331b5d84f594872d2fc..e2663a022094b65e5fc5f2aa6e2d303508c2a83b 100644 (file)
--- a/src/libpspp/i18n.h
+++ b/src/libpspp/i18n.h
@@ -1,41 +1,67 @@
-/* PSPP - computes sample statistics.
+/* PSPP - a program for statistical analysis.
    Copyright (C) 2006 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 the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   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 3 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.
+   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. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #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);
+void  i18n_done (void);
+void  i18n_init (void);
 
-enum conv_id
-  {
-    CONV_PSPP_TO_UTF8,
-    CONV_SYSTEM_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 */