epoc32/include/stdapis/libxml2/libxml2_xmlstring.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100 (2010-03-31)
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
 * Summary: set of routines to process strings
williamr@4
     3
 * Description: type and interfaces needed for the internal string handling
williamr@4
     4
 *              of the library, especially UTF8 processing.
williamr@4
     5
 *
williamr@4
     6
 * Copy: See Copyright for the status of this software.
williamr@4
     7
 *
williamr@4
     8
 * Author: Daniel Veillard
williamr@4
     9
 * Portion Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. 
williamr@4
    10
 */
williamr@4
    11
williamr@4
    12
/** @file
williamr@4
    13
@publishedAll
williamr@4
    14
@released
williamr@4
    15
*/
williamr@4
    16
williamr@4
    17
#ifndef XML_STRING_H
williamr@4
    18
#define XML_STRING_H
williamr@4
    19
williamr@4
    20
#include <stdarg.h>
williamr@4
    21
#include <stdapis/libxml2/libxml2_xmlversion.h>
williamr@4
    22
williamr@4
    23
#ifdef __cplusplus
williamr@4
    24
extern "C" {
williamr@4
    25
#endif
williamr@4
    26
williamr@4
    27
/**
williamr@4
    28
 * xmlChar:
williamr@4
    29
 *
williamr@4
    30
 * This is a basic byte in an UTF-8 encoded string.
williamr@4
    31
 * It's unsigned allowing to pinpoint case where char * are assigned
williamr@4
    32
 * to xmlChar * (possibly making serialization back impossible).
williamr@4
    33
 */
williamr@4
    34
williamr@4
    35
typedef unsigned char xmlChar;
williamr@4
    36
williamr@4
    37
/**
williamr@4
    38
 * BAD_CAST:
williamr@4
    39
 *
williamr@4
    40
 * Macro to cast a string to an xmlChar * when one know its safe.
williamr@4
    41
 */
williamr@4
    42
#define BAD_CAST (xmlChar *)
williamr@4
    43
williamr@4
    44
/*
williamr@4
    45
 * xmlChar handling
williamr@4
    46
 */
williamr@4
    47
XMLPUBFUN xmlChar* XMLCALL
williamr@4
    48
                xmlStrdup                (const xmlChar *cur);
williamr@4
    49
XMLPUBFUN xmlChar* XMLCALL
williamr@4
    50
                xmlStrndup               (const xmlChar *cur,
williamr@4
    51
                                         int len);
williamr@4
    52
XMLPUBFUN xmlChar* XMLCALL
williamr@4
    53
                xmlCharStrndup           (const char *cur,
williamr@4
    54
                                         int len);
williamr@4
    55
XMLPUBFUN xmlChar* XMLCALL
williamr@4
    56
                xmlCharStrdup            (const char *cur);
williamr@4
    57
XMLPUBFUN xmlChar* XMLCALL
williamr@4
    58
                xmlStrsub                (const xmlChar *str,
williamr@4
    59
                                         int start,
williamr@4
    60
                                         int len);
williamr@4
    61
XMLPUBFUN const xmlChar* XMLCALL
williamr@4
    62
                xmlStrchr                (const xmlChar *str,
williamr@4
    63
                                         xmlChar val);
williamr@4
    64
XMLPUBFUN const xmlChar* XMLCALL
williamr@4
    65
                xmlStrstr                (const xmlChar *str,
williamr@4
    66
                                         const xmlChar *val);
williamr@4
    67
XMLPUBFUN const xmlChar* XMLCALL
williamr@4
    68
                xmlStrcasestr            (const xmlChar *str,
williamr@4
    69
                                         xmlChar *val);
williamr@4
    70
XMLPUBFUN int XMLCALL
williamr@4
    71
                xmlStrcmp                (const xmlChar *str1,
williamr@4
    72
                                         const xmlChar *str2);
williamr@4
    73
XMLPUBFUN int XMLCALL
williamr@4
    74
                xmlStrncmp               (const xmlChar *str1,
williamr@4
    75
                                         const xmlChar *str2,
williamr@4
    76
                                         int len);
williamr@4
    77
XMLPUBFUN int XMLCALL
williamr@4
    78
                xmlStrcasecmp            (const xmlChar *str1,
williamr@4
    79
                                         const xmlChar *str2);
williamr@4
    80
XMLPUBFUN int XMLCALL
williamr@4
    81
                xmlStrncasecmp           (const xmlChar *str1,
williamr@4
    82
                                         const xmlChar *str2,
williamr@4
    83
                                         int len);
williamr@4
    84
XMLPUBFUN int XMLCALL
williamr@4
    85
                xmlStrEqual              (const xmlChar *str1,
williamr@4
    86
                                         const xmlChar *str2);
williamr@4
    87
XMLPUBFUN int XMLCALL
williamr@4
    88
                xmlStrQEqual             (const xmlChar *pref,
williamr@4
    89
                                         const xmlChar *name,
williamr@4
    90
                                         const xmlChar *str);
williamr@4
    91
XMLPUBFUN int XMLCALL
williamr@4
    92
                xmlStrlen                (const xmlChar *str);
williamr@4
    93
XMLPUBFUN xmlChar* XMLCALL
williamr@4
    94
                xmlStrcat                (xmlChar *cur,
williamr@4
    95
                                         const xmlChar *add);
williamr@4
    96
XMLPUBFUN xmlChar* XMLCALL
williamr@4
    97
                xmlStrncat               (xmlChar *cur,
williamr@4
    98
                                         const xmlChar *add,
williamr@4
    99
                                         int len);
williamr@4
   100
XMLPUBFUN xmlChar* XMLCALL
williamr@4
   101
                xmlStrncatNew            (const xmlChar *str1,
williamr@4
   102
                                         const xmlChar *str2,
williamr@4
   103
                                         int len);
williamr@4
   104
XMLPUBFUN int XMLCALL
williamr@4
   105
                xmlStrPrintf             (xmlChar *buf,
williamr@4
   106
                                         int len,
williamr@4
   107
                                         const xmlChar *msg,
williamr@4
   108
                                         ...);
williamr@4
   109
XMLPUBFUN int XMLCALL
williamr@4
   110
                xmlStrVPrintf                (xmlChar *buf,
williamr@4
   111
                                         int len,
williamr@4
   112
                                         const xmlChar *msg,
williamr@4
   113
                                         va_list ap);
williamr@4
   114
williamr@4
   115
XMLPUBFUN int XMLCALL
williamr@4
   116
        xmlGetUTF8Char                   (const unsigned char *utf,  int *len);
williamr@4
   117
williamr@4
   118
#ifndef XMLENGINE_EXCLUDE_UNUSED
williamr@4
   119
XMLPUBFUN int XMLCALL xmlCheckUTF8 (const unsigned char *utf);
williamr@4
   120
#endif /* ifndef XMLENGINE_EXCLUDE_UNUSED */
williamr@4
   121
williamr@4
   122
XMLPUBFUN int XMLCALL
williamr@4
   123
        xmlUTF8Strsize                   (const xmlChar *utf,
williamr@4
   124
                                         int len);
williamr@4
   125
XMLPUBFUN xmlChar* XMLCALL
williamr@4
   126
        xmlUTF8Strndup                   (const xmlChar *utf,
williamr@4
   127
                                         int len);
williamr@4
   128
XMLPUBFUN xmlChar* XMLCALL
williamr@4
   129
        xmlUTF8Strpos                    (const xmlChar *utf,
williamr@4
   130
                                         int pos);
williamr@4
   131
XMLPUBFUN int XMLCALL
williamr@4
   132
        xmlUTF8Strloc                    (const xmlChar *utf,
williamr@4
   133
                                         const xmlChar *utfchar);
williamr@4
   134
XMLPUBFUN xmlChar* XMLCALL
williamr@4
   135
        xmlUTF8Strsub                    (const xmlChar *utf,
williamr@4
   136
                                         int start,
williamr@4
   137
                                         int len);
williamr@4
   138
XMLPUBFUN int XMLCALL
williamr@4
   139
        xmlUTF8Strlen                    (const xmlChar *utf);
williamr@4
   140
XMLPUBFUN int XMLCALL
williamr@4
   141
        xmlUTF8Size                      (const xmlChar *utf);
williamr@4
   142
XMLPUBFUN int XMLCALL
williamr@4
   143
        xmlUTF8Charcmp                   (const xmlChar *utf1,
williamr@4
   144
                                         const xmlChar *utf2);
williamr@4
   145
williamr@4
   146
#ifdef __cplusplus
williamr@4
   147
}
williamr@4
   148
#endif
williamr@4
   149
#endif /* XML_STRING_H */
williamr@4
   150