stringprep.h.in

   1 /* stringprep.h         header file for libstringprep                 -*- c -*-
   2  * Copyright (C) 2002  Simon Josefsson
   3  *
   4  * This file is part of Libstringprep.
   5  *
   6  * Libstringprep is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * Libstringprep is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with Libstringprep; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifndef _STRINGPREP_H
  23 #define _STRINGPREP_H
  24
  25 #ifdef __cplusplus
  26 extern "C"
  27 {
  28 #endif
  29
  30 #define STRINGPREP_VERSION "@PACKAGE_VERSION@"
  31
  32 /* Error codes. */
  33   enum
  34   {
  35     STRINGPREP_OK = 0,
  36     /* Stringprep errors. */
  37     STRINGPREP_CONTAINS_UNASSIGNED = 1,
  38     STRINGPREP_CONTAINS_PROHIBITED = 2,
  39     STRINGPREP_BIDI_BOTH_L_AND_RAL = 3,
  40     STRINGPREP_BIDI_LEADTRAIL_NOT_RAL = 4,
  41     STRINGPREP_BIDI_CONTAINS_PROHIBITED = 5,
  42     /* Error in calling application. */
  43     STRINGPREP_TOO_SMALL_BUFFER = 100,
  44     STRINGPREP_PROFILE_ERROR = 101,
  45     STRINGPREP_FLAG_ERROR = 102,
  46     /* Internal errors. */
  47     STRINGPREP_NFKC_FAILED = 200,
  48     STRINGPREP_MALLOC_ERROR = 201
  49   };
  50
  51 /* Flags used when calling stringprep(). */
  52   enum
  53   {
  54     STRINGPREP_NO_NFKC = 1,
  55     STRINGPREP_NO_BIDI = 2,
  56     STRINGPREP_NO_UNASSIGNED = 4
  57   };
  58
  59 /* Steps in a stringprep profile. */
  60   enum
  61   {
  62     STRINGPREP_NFKC = 1,
  63     STRINGPREP_BIDI = 2,
  64     STRINGPREP_MAP_TABLE = 3,
  65     STRINGPREP_UNASSIGNED_TABLE = 4,
  66     STRINGPREP_PROHIBIT_TABLE = 5,
  67     STRINGPREP_BIDI_PROHIBIT_TABLE = 6,
  68     STRINGPREP_BIDI_RAL_TABLE = 7,
  69     STRINGPREP_BIDI_L_TABLE = 8
  70   };
  71
  72 #define STRINGPREP_MAX_MAP_CHARS 5
  73
  74   struct Stringprep_table_element
  75   {
  76     unsigned long start;
  77     unsigned long end;                          /* 0 if only one character */
  78     unsigned long map[STRINGPREP_MAX_MAP_CHARS];/* NULL if end is not 0 */
  79   };
  80   typedef struct Stringprep_table_element Stringprep_table_element;
  81
  82   struct Stringprep_table
  83   {
  84     int operation;
  85     int flags;
  86     Stringprep_table_element *table;
  87     char *name;
  88   };
  89   typedef struct Stringprep_table Stringprep_profile;
  90
  91 /* API */
  92
  93   extern int stringprep (char *in, int maxlen, int flags,
  94                          Stringprep_profile * profile);
  95
  96   extern const char *stringprep_check_version (const char *req_version);
  97
  98 /* Utility */
  99
 100   extern int stringprep_unichar_to_utf8 (unsigned long c, char *outbuf);
 101   extern unsigned long stringprep_utf8_to_unichar (const char *p);
 102
 103   extern unsigned long *stringprep_utf8_to_ucs4 (const char *str, int len,
 104                                                  int *items_written);
 105   extern char *stringprep_ucs4_to_utf8 (const unsigned long *str, int len,
 106                                         int *items_read, int *items_written);
 107
 108   extern char *stringprep_utf8_nfkc_normalize (const char *str, int len);
 109   extern unsigned long *stringprep_ucs4_nfkc_normalize (unsigned long *str,
 110                                                         int len);
 111
 112   extern const char *stringprep_locale_charset ();
 113   extern char *stringprep_convert (const char *str,
 114                                    const char *to_codeset,
 115                                    const char *from_codeset);
 116   extern char *stringprep_locale_to_utf8 (const char *str);
 117
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121 #endif                          /* _STRINGPREP_H */