include/yaz/charneg.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 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
  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 Z_External *yaz_set_proposal_charneg_list(ODR o,
  73                                           const char *delim,
  74                                           const char *charset_list,
  75                                           const char *lang_list,
  76                                           int selected);
  77
  78 YAZ_EXPORT
  79 void yaz_get_response_charneg(NMEM mem,
  80                               Z_CharSetandLanguageNegotiation *p,
  81                               char **charset, char **lang,
  82                               int *selected);
  83
  84 /*
  85  * Server's part
  86  */
  87
  88 YAZ_EXPORT
  89 Z_External *yaz_set_response_charneg(ODR odr,
  90                                      const char *charset, const char *lang,
  91                                      int selected);
  92
  93
  94 YAZ_EXPORT
  95 void yaz_get_proposal_charneg(NMEM mem,
  96                               Z_CharSetandLanguageNegotiation *p,
  97                               char ***charsets, int *num_charsets,
  98                               char ***langs, int *num_langs,
  99                               int *selected);
 100
 101
 102 YAZ_END_CDECL
 103
 104 #endif
 105 /*
 106  * Local variables:
 107  * c-basic-offset: 4
 108  * c-file-style: "Stroustrup"
 109  * indent-tabs-mode: nil
 110  * End:
 111  * vim: shiftwidth=4 tabstop=8 expandtab
 112  */
 113