include/yaz/charneg.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 /* $Id: charneg.h,v 1.10 2007-01-03 08:42:14 adam Exp $ */
  28
  29 /**
  30  * \file charneg.h
  31  * \brief Header for Z39.50 Charset negotiation utilities
  32  *
  33  * Helper functions for Character Set and Language Negotiation - 3
  34  */
  35 #ifndef CHARNEG_H
  36 #define CHARNEG_H
  37
  38 #include <yaz/proto.h>
  39
  40 YAZ_BEGIN_CDECL
  41
  42 /*
  43  * Character set and language negotiation model - 3 (*)
  44  *
  45  * These a set helper functions for support (*). There are
  46  * client and server parts. At that moment the (*) is based on
  47  * Z_PrivateCharacterSet_externallySpecified method.
  48  *
  49  */
  50
  51 /*
  52  * Get (*) record from request
  53  */
  54 YAZ_EXPORT
  55 Z_CharSetandLanguageNegotiation *yaz_get_charneg_record(Z_OtherInformation *p);
  56
  57 /*
  58  * Delete (*) record from request
  59  */
  60 YAZ_EXPORT
  61 int yaz_del_charneg_record(Z_OtherInformation **p);
  62
  63 /*
  64  * Client's part.
  65  */
  66 YAZ_EXPORT
  67 Z_External *yaz_set_proposal_charneg(ODR odr,
  68                                      const char **charsets, int num_charsets,
  69                                      const char **langs,
  70                                      int num_langs, int selected);
  71
  72 YAZ_EXPORT
  73 Z_External *yaz_set_proposal_charneg_list(ODR o,
  74                                           const char *delim,
  75                                           const char *charset_list,
  76                                           const char *lang_list,
  77                                           int selected);
  78
  79 YAZ_EXPORT
  80 void yaz_get_response_charneg(NMEM mem,
  81                               Z_CharSetandLanguageNegotiation *p,
  82                               char **charset, char **lang,
  83                               int *selected);
  84
  85 /*
  86  * Server's part
  87  */
  88
  89 YAZ_EXPORT
  90 Z_External *yaz_set_response_charneg(ODR odr,
  91                                      const char *charset, const char *lang,
  92                                      int selected);
  93
  94
  95 YAZ_EXPORT
  96 void yaz_get_proposal_charneg(NMEM mem,
  97                               Z_CharSetandLanguageNegotiation *p,
  98                               char ***charsets, int *num_charsets,
  99                               char ***langs, int *num_langs,
 100                               int *selected);
 101
 102
 103 YAZ_END_CDECL
 104
 105 #endif
 106 /*
 107  * Local variables:
 108  * c-basic-offset: 4
 109  * indent-tabs-mode: nil
 110  * End:
 111  * vim: shiftwidth=4 tabstop=8 expandtab
 112  */
 113