granicus.if.org Git - apache/blob - include/util_charset.h

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file  util_charset.h
  19  * @brief charset conversion
  20  *
  21  * @defgroup APACHE_CORE_CHARSET Charset Conversion
  22  * @ingroup  APACHE_CORE
  23  *
  24  * These are the translation handles used to translate between the network
  25  * format of protocol headers and the local machine format.
  26  *
  27  * For an EBCDIC machine, these are valid handles which are set up at
  28  * initialization to translate between ISO-8859-1 and the code page of
  29  * the source code.\n
  30  * For an ASCII machine, they are undefined.
  31  *
  32  * @see ap_init_ebcdic()
  33  * @{
  34  */
  35
  36 #ifndef APACHE_UTIL_CHARSET_H
  37 #define APACHE_UTIL_CHARSET_H
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 #include "apr.h"
  44
  45 #if APR_CHARSET_EBCDIC || defined(DOXYGEN)
  46
  47 #include "apr_xlate.h"
  48
  49 /**
  50  * On EBCDIC machine this is a translation handle used to translate the
  51  * headers from the local machine format to ASCII for network transmission.
  52  * @note On ASCII system, this variable does <b>not</b> exist.
  53  * So, its use should be guarded by \#if APR_CHARSET_EBCDIC.
  54  */
  55 extern apr_xlate_t *ap_hdrs_to_ascii;
  56
  57 /**
  58  * On EBCDIC machine this is a translation handle used to translate the
  59  * headers from ASCII to the local machine format after network transmission.
  60  * @note On ASCII system, this variable does <b>not</b> exist.
  61  * So, its use should be guarded by \#if APR_CHARSET_EBCDIC.
  62  */
  63 extern apr_xlate_t *ap_hdrs_from_ascii;
  64
  65 #endif  /* APR_CHARSET_EBCDIC */
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif  /* !APACHE_UTIL_CHARSET_H */
  72 /** @} */