include/yaz/charneg.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The name of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Id: charneg.h,v 1.6 2005-05-18 12:38:40 adam Exp $
  27  */
  28 /**
  29  * \file charneg.h
  30  * \brief Header for Z39.50 Charset negotiation utilities
  31  *
  32  * Helper functions for Character Set and Language Negotiation - 3
  33  */
  34 #ifndef CHARNEG_H
  35 #define CHARNEG_H
  36
  37 #include <yaz/proto.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 /*
  42  * Character set and language negotiation model - 3 (*)
  43  *
  44  * These a set helper functions for support (*). There are
  45  * client and server parts. At that moment the (*) is based on
  46  * Z_PrivateCharacterSet_externallySpecified method.
  47  *
  48  */
  49
  50 /*
  51  * Get (*) record from request
  52  */
  53 YAZ_EXPORT
  54 Z_CharSetandLanguageNegotiation *yaz_get_charneg_record(Z_OtherInformation *p);
  55
  56 /*
  57  * Delete (*) record from request
  58  */
  59 YAZ_EXPORT
  60 int yaz_del_charneg_record(Z_OtherInformation **p);
  61
  62 /*
  63  * Client's part.
  64  */
  65 YAZ_EXPORT
  66 Z_External *yaz_set_proposal_charneg(ODR odr,
  67                                      const char **charsets, int num_charsets,
  68                                      const char **langs,
  69                                      int num_langs, int selected);
  70
  71 YAZ_EXPORT
  72 void yaz_get_response_charneg(NMEM mem,
  73                               Z_CharSetandLanguageNegotiation *p,
  74                               char **charset, char **lang,
  75                               int *selected);
  76
  77 /*
  78  * Server's part
  79  */
  80
  81 YAZ_EXPORT
  82 Z_External *yaz_set_response_charneg(ODR odr,
  83                                      const char *charset, const char *lang,
  84                                      int selected);
  85
  86
  87 YAZ_EXPORT
  88 void yaz_get_proposal_charneg(NMEM mem,
  89                               Z_CharSetandLanguageNegotiation *p,
  90                               char ***charsets, int *num_charsets,
  91                               char ***langs, int *num_langs,
  92                               int *selected);
  93 YAZ_END_CDECL
  94
  95 #endif