Main Page | Modules | Namespace List | Data Structures | File List | Data Fields | Globals | Related Pages

apr_xlate.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  */
00054 
00055 #ifndef APR_XLATE_H
00056 #define APR_XLATE_H
00057 
00058 #include "apu.h"
00059 #include "apr_pools.h"
00060 #include "apr_errno.h"
00061 
00062 #ifdef __cplusplus
00063 extern "C" {
00064 #endif /* __cplusplus */
00065 
00077 typedef struct apr_xlate_t            apr_xlate_t;
00078 
00104 APU_DECLARE(apr_status_t) apr_xlate_open(apr_xlate_t **convset, 
00105                                          const char *topage, 
00106                                          const char *frompage, 
00107                                          apr_pool_t *pool);
00108 
00116 #define APR_DEFAULT_CHARSET (const char *)0
00120 #define APR_LOCALE_CHARSET (const char *)1
00121 
00131 APU_DECLARE(apr_status_t) apr_xlate_sb_get(apr_xlate_t *convset, int *onoff);
00132 
00134 APU_DECLARE(apr_status_t) apr_xlate_get_sb(apr_xlate_t *convset, int *onoff);
00135 
00150 APU_DECLARE(apr_status_t) apr_xlate_conv_buffer(apr_xlate_t *convset, 
00151                                                 const char *inbuf, 
00152                                                 apr_size_t *inbytes_left, 
00153                                                 char *outbuf,
00154                                                 apr_size_t *outbytes_left);
00155 
00156 /* @see apr_file_io.h the comment in apr_file_io.h about this hack */
00157 #ifdef APR_NOT_DONE_YET
00167 APU_DECLARE(apr_status_t) apr_xlate_conv_char(apr_xlate_t *convset, 
00168                                               char inchar, char outchar);
00169 #endif
00170 
00179 APU_DECLARE(apr_int32_t) apr_xlate_conv_byte(apr_xlate_t *convset, 
00180                                              unsigned char inchar);
00181 
00189 APU_DECLARE(apr_status_t) apr_xlate_close(apr_xlate_t *convset);
00190 
00192 #ifdef __cplusplus
00193 }
00194 #endif
00195 
00196 #endif  /* ! APR_XLATE_H */

Generated on Wed Dec 8 00:35:23 2010 for Apache Portable Runtime Utility Library by  doxygen 1.3.9.1