include/yaz/charneg.h

   1 /*
   2  * Copyright (c) 2002-2004, Index Data.
   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.4 2004-10-15 00:18:59 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 Z_CharSetandLanguageNegotiation *
  54         yaz_get_charneg_record(Z_OtherInformation *p);
  55
  56 /*
  57  * Client's part.
  58  */
  59 YAZ_EXPORT Z_External *yaz_set_proposal_charneg(ODR odr,
  60         const char **charsets, int num_charsets, const char **langs,
  61                 int num_langs, int selected);
  62
  63 YAZ_EXPORT void yaz_get_response_charneg(NMEM mem,
  64         Z_CharSetandLanguageNegotiation *p, char **charset, char **lang,
  65                 int *selected);
  66
  67 /*
  68  * Server's part
  69  */
  70
  71 YAZ_EXPORT Z_External *yaz_set_response_charneg(ODR odr,
  72         const char *charset, const char *lang, int selected);
  73
  74
  75 YAZ_EXPORT void yaz_get_proposal_charneg(NMEM mem,
  76         Z_CharSetandLanguageNegotiation *p,
  77                                          char ***charsets, int *num_charsets,
  78                                          char ***langs, int *num_langs,
  79                                          int *selected);
  80
  81
  82 YAZ_END_CDECL
  83
  84 #endif