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 UTF8_H
18#define UTF8_H
19
20#include "apr.h"
21#include "apr_lib.h"
22#include "apr_errno.h"
23
24/* If we ever support anything more exciting than char... this could move.
25 */
26typedef apr_uint16_t apr_wchar_t;
27
28/**
29 * An APR internal function for fast utf-8 octet-encoded Unicode conversion
30 * to the ucs-2 wide Unicode format.  This function is used for filename and
31 * other resource conversions for platforms providing native Unicode support.
32 *
33 * @tip Only the errors APR_EINVAL and APR_INCOMPLETE may occur, the former
34 * when the character code is invalid (in or out of context) and the later
35 * when more characters were expected, but insufficient characters remain.
36 */
37APR_DECLARE(apr_status_t) apr_conv_utf8_to_ucs2(const char *in,
38                                                apr_size_t *inbytes,
39                                                apr_wchar_t *out,
40                                                apr_size_t *outwords);
41
42/**
43 * An APR internal function for fast ucs-2 wide Unicode format conversion to
44 * the utf-8 octet-encoded Unicode.  This function is used for filename and
45 * other resource conversions for platforms providing native Unicode support.
46 *
47 * @tip Only the errors APR_EINVAL and APR_INCOMPLETE may occur, the former
48 * when the character code is invalid (in or out of context) and the later
49 * when more words were expected, but insufficient words remain.
50 */
51APR_DECLARE(apr_status_t) apr_conv_ucs2_to_utf8(const apr_wchar_t *in,
52                                                apr_size_t *inwords,
53                                                char *out,
54                                                apr_size_t *outbytes);
55
56#endif /* def UTF8_H */
57