Apache Portable Runtime Utility Library
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apr_xlate.h
Go to the documentation of this file.
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 #ifndef APR_XLATE_H
18 #define APR_XLATE_H
19 
20 #include "apu.h"
21 #include "apr_pools.h"
22 #include "apr_errno.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif /* __cplusplus */
27 
39 typedef struct apr_xlate_t apr_xlate_t;
40 
66 APU_DECLARE(apr_status_t) apr_xlate_open(apr_xlate_t **convset,
67  const char *topage,
68  const char *frompage,
69  apr_pool_t *pool);
70 
78 #define APR_DEFAULT_CHARSET (const char *)0
79 
82 #define APR_LOCALE_CHARSET (const char *)1
83 
93 APU_DECLARE(apr_status_t) apr_xlate_sb_get(apr_xlate_t *convset, int *onoff);
94 
117 APU_DECLARE(apr_status_t) apr_xlate_conv_buffer(apr_xlate_t *convset,
118  const char *inbuf,
119  apr_size_t *inbytes_left,
120  char *outbuf,
121  apr_size_t *outbytes_left);
122 
123 /* @see apr_file_io.h the comment in apr_file_io.h about this hack */
124 #ifdef APR_NOT_DONE_YET
125 
134 APU_DECLARE(apr_status_t) apr_xlate_conv_char(apr_xlate_t *convset,
135  char inchar, char outchar);
136 #endif
137 
146 APU_DECLARE(apr_int32_t) apr_xlate_conv_byte(apr_xlate_t *convset,
147  unsigned char inchar);
148 
156 APU_DECLARE(apr_status_t) apr_xlate_close(apr_xlate_t *convset);
157 
159 #ifdef __cplusplus
160 }
161 #endif
162 
163 #endif /* ! APR_XLATE_H */