More comments.

[disorder] / lib / charset.h

diff --git a/lib/charset.h b/lib/charset.h
index 369d2b9b7da0b298a6c380e8921c37779aaf51d5..be2b05a45ae5a3ced48f189fb1b69167b701a330 100644 (file)
--- a/lib/charset.h
+++ b/lib/charset.h
@@ -1,29 +1,30 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004, 2005 Richard Kettlewell
+ * Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * 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
+ * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+/** @file lib/charset.h @brief Character set conversion */
 #ifndef CHARSET_H
 #define CHARSET_H
 
+#include "log.h"
+
+struct dynstr;
+
 /* Character encoding conversion routines */
 
-uint32_t *utf82ucs4(const char *mb);
-char *ucs42utf8(const uint32_t *u);
 char *mb2utf8(const char *mb);
 char *utf82mb(const char *utf8);
 /* various conversions, between multibyte strings (mb) in
@@ -48,14 +49,18 @@ char *any2any(const char *from/*encoding or 0*/,
  * that iconv knows.  If FROM and TO are both 0 then ANY is returned
  * unchanged. */
 
-
+/** @brief Insist that @p s is not null
+ * @param s Pointer to check
+ * @return @p s
+ *
+ * Terminates the process if @p s is a null pointer.
+ */
 static inline char *nullcheck(char *s) {
   if(!s) exitfn(1);                    /* assume an error already reported */
   return s;
 }
 
-int ucs4cmp(const uint32_t *a, const uint32_t *b);
-/* like strcmp */
+const char *truncate_for_display(const char *s, long max);
 
 #endif /* CHARSET_H */