FilesExpand file tree

 master

/

codecs.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

240 lines (171 loc) · 6.63 KB

 master

/

codecs.h

Copy path

Top

File metadata and controls

• Code
• Blame

240 lines (171 loc) · 6.63 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

#ifndef Py_CODECREGISTRY_H

#define Py_CODECREGISTRY_H

#ifdef __cplusplus

extern "C" {

#endif

/* ------------------------------------------------------------------------

Python Codec Registry and support functions

Written by Marc-Andre Lemburg (mal@lemburg.com).

Copyright (c) Corporation for National Research Initiatives.

------------------------------------------------------------------------ */

/* Register a new codec search function.

As side effect, this tries to load the encodings package, if not

yet done, to make sure that it is always first in the list of

search functions.

The search_function's refcount is incremented by this function. */

PyAPI_FUNC(int) PyCodec_Register(

PyObject *search_function

);

/* Codec registry lookup API.

Looks up the given encoding and returns a CodecInfo object with

function attributes which implement the different aspects of

processing the encoding.

The encoding string is looked up converted to all lower-case

characters. This makes encodings looked up through this mechanism

effectively case-insensitive.

If no codec is found, a KeyError is set and NULL returned.

As side effect, this tries to load the encodings package, if not

yet done. This is part of the lazy load strategy for the encodings

package.

*/

#ifndef Py_LIMITED_API

PyAPI_FUNC(PyObject *) _PyCodec_Lookup(

const char *encoding

);

PyAPI_FUNC(int) _PyCodec_Forget(

const char *encoding

);

#endif

/* Codec registry encoding check API.

Returns 1/0 depending on whether there is a registered codec for

the given encoding.

*/

PyAPI_FUNC(int) PyCodec_KnownEncoding(

const char *encoding

);

/* Generic codec based encoding API.

object is passed through the encoder function found for the given

encoding using the error handling method defined by errors. errors

may be NULL to use the default method defined for the codec.

Raises a LookupError in case no encoder can be found.

*/

PyAPI_FUNC(PyObject *) PyCodec_Encode(

PyObject *object,

const char *encoding,

const char *errors

);

/* Generic codec based decoding API.

object is passed through the decoder function found for the given

encoding using the error handling method defined by errors. errors

may be NULL to use the default method defined for the codec.

Raises a LookupError in case no encoder can be found.

*/

PyAPI_FUNC(PyObject *) PyCodec_Decode(

PyObject *object,

const char *encoding,

const char *errors

);

#ifndef Py_LIMITED_API

/* Text codec specific encoding and decoding API.

Checks the encoding against a list of codecs which do not

implement a str<->bytes encoding before attempting the

operation.

Please note that these APIs are internal and should not

be used in Python C extensions.

XXX (ncoghlan): should we make these, or something like them, public

in Python 3.5+?

*/

PyAPI_FUNC(PyObject *) _PyCodec_LookupTextEncoding(

const char *encoding,

const char *alternate_command

);

PyAPI_FUNC(PyObject *) _PyCodec_EncodeText(

PyObject *object,

const char *encoding,

const char *errors

);

PyAPI_FUNC(PyObject *) _PyCodec_DecodeText(

PyObject *object,

const char *encoding,

const char *errors

);

/* These two aren't actually text encoding specific, but _io.TextIOWrapper

* is the only current API consumer.

*/

PyAPI_FUNC(PyObject *) _PyCodecInfo_GetIncrementalDecoder(

PyObject *codec_info,

const char *errors

);

PyAPI_FUNC(PyObject *) _PyCodecInfo_GetIncrementalEncoder(

PyObject *codec_info,

const char *errors

);

#endif

/* --- Codec Lookup APIs --------------------------------------------------

All APIs return a codec object with incremented refcount and are

based on _PyCodec_Lookup(). The same comments w/r to the encoding

name also apply to these APIs.

*/

/* Get an encoder function for the given encoding. */

PyAPI_FUNC(PyObject *) PyCodec_Encoder(

const char *encoding

);

/* Get a decoder function for the given encoding. */

PyAPI_FUNC(PyObject *) PyCodec_Decoder(

const char *encoding

);

/* Get an IncrementalEncoder object for the given encoding. */

PyAPI_FUNC(PyObject *) PyCodec_IncrementalEncoder(

const char *encoding,

const char *errors

);

/* Get an IncrementalDecoder object function for the given encoding. */

PyAPI_FUNC(PyObject *) PyCodec_IncrementalDecoder(

const char *encoding,

const char *errors

);

/* Get a StreamReader factory function for the given encoding. */

PyAPI_FUNC(PyObject *) PyCodec_StreamReader(

const char *encoding,

PyObject *stream,

const char *errors

);

/* Get a StreamWriter factory function for the given encoding. */

PyAPI_FUNC(PyObject *) PyCodec_StreamWriter(

const char *encoding,

PyObject *stream,

const char *errors

);

/* Unicode encoding error handling callback registry API */

/* Register the error handling callback function error under the given

name. This function will be called by the codec when it encounters

unencodable characters/undecodable bytes and doesn't know the

callback name, when name is specified as the error parameter

in the call to the encode/decode function.

Return 0 on success, -1 on error */

PyAPI_FUNC(int) PyCodec_RegisterError(const char *name, PyObject *error);

/* Lookup the error handling callback function registered under the given

name. As a special case NULL can be passed, in which case

the error handling callback for "strict" will be returned. */

PyAPI_FUNC(PyObject *) PyCodec_LookupError(const char *name);

/* raise exc as an exception */

PyAPI_FUNC(PyObject *) PyCodec_StrictErrors(PyObject *exc);

/* ignore the unicode error, skipping the faulty input */

PyAPI_FUNC(PyObject *) PyCodec_IgnoreErrors(PyObject *exc);

/* replace the unicode encode error with ? or U+FFFD */

PyAPI_FUNC(PyObject *) PyCodec_ReplaceErrors(PyObject *exc);

/* replace the unicode encode error with XML character references */

PyAPI_FUNC(PyObject *) PyCodec_XMLCharRefReplaceErrors(PyObject *exc);

/* replace the unicode encode error with backslash escapes (\x, \u and \U) */

PyAPI_FUNC(PyObject *) PyCodec_BackslashReplaceErrors(PyObject *exc);

#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000

/* replace the unicode encode error with backslash escapes (\N, \x, \u and \U) */

PyAPI_FUNC(PyObject *) PyCodec_NameReplaceErrors(PyObject *exc);

#endif

#ifndef Py_LIMITED_API

PyAPI_DATA(const char *) Py_hexdigits;

#endif

#ifdef __cplusplus

}

#endif

#endif /* !Py_CODECREGISTRY_H */