transcode.h

Go to the documentation of this file.

#ifndef RUBY_INTERNAL_ENCODING_TRANSCODE_H           /*-*-C++-*-vi:se ft=cpp:*/
#define RUBY_INTERNAL_ENCODING_TRANSCODE_H
#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"
 
RBIMPL_SYMBOL_EXPORT_BEGIN()
 
 
typedef enum {
 
    econv_invalid_byte_sequence,
 
    econv_undefined_conversion,
 
    econv_destination_buffer_full,
 
    econv_source_buffer_empty,
 
    econv_finished,
 
    econv_after_output,
 
    econv_incomplete_input
} rb_econv_result_t;
 
typedef struct rb_econv_t rb_econv_t;
 
VALUE rb_str_encode(VALUE str, VALUE to, int ecflags, VALUE ecopts);
 
int rb_econv_has_convpath_p(const char* from_encoding, const char* to_encoding);
 
int rb_econv_prepare_options(VALUE opthash, VALUE *ecopts, int ecflags);
 
int rb_econv_prepare_opts(VALUE opthash, VALUE *ecopts);
 
rb_econv_t *rb_econv_open(const char *source_encoding, const char *destination_encoding, int ecflags);
 
rb_econv_t *rb_econv_open_opts(const char *source_encoding, const char *destination_encoding, int ecflags, VALUE ecopts);
 
rb_econv_result_t rb_econv_convert(rb_econv_t *ec,
    const unsigned char **source_buffer_ptr, const unsigned char *source_buffer_end,
    unsigned char **destination_buffer_ptr, unsigned char *destination_buffer_end,
    int flags);
 
void rb_econv_close(rb_econv_t *ec);
 
int rb_econv_set_replacement(rb_econv_t *ec, const unsigned char *str, size_t len, const char *encname);
 
int rb_econv_decorate_at_first(rb_econv_t *ec, const char *decorator_name);
 
int rb_econv_decorate_at_last(rb_econv_t *ec, const char *decorator_name);
 
VALUE rb_econv_open_exc(const char *senc, const char *denc, int ecflags);
 
int rb_econv_insert_output(rb_econv_t *ec,
    const unsigned char *str, size_t len, const char *str_encoding);
 
const char *rb_econv_encoding_to_insert_output(rb_econv_t *ec);
 
void rb_econv_check_error(rb_econv_t *ec);
 
VALUE rb_econv_make_exception(rb_econv_t *ec);
 
int rb_econv_putbackable(rb_econv_t *ec);
 
void rb_econv_putback(rb_econv_t *ec, unsigned char *p, int n);
 
const char *rb_econv_asciicompat_encoding(const char *encname);
 
VALUE rb_econv_str_convert(rb_econv_t *ec, VALUE src, int flags);
 
VALUE rb_econv_substr_convert(rb_econv_t *ec, VALUE src, long byteoff, long bytesize, int flags);
 
VALUE rb_econv_str_append(rb_econv_t *ec, VALUE src, VALUE dst, int flags);
 
VALUE rb_econv_substr_append(rb_econv_t *ec, VALUE src, long byteoff, long bytesize, VALUE dst, int flags);
 
VALUE rb_econv_append(rb_econv_t *ec, const char *bytesrc, long bytesize, VALUE dst, int flags);
 
void rb_econv_binmode(rb_econv_t *ec);
 
enum ruby_econv_flag_type {
 
    RUBY_ECONV_ERROR_HANDLER_MASK               = 0x000000ff,
 
    RUBY_ECONV_INVALID_MASK                     = 0x0000000f,
 
    RUBY_ECONV_INVALID_REPLACE                  = 0x00000002,
 
    RUBY_ECONV_UNDEF_MASK                       = 0x000000f0,
 
    RUBY_ECONV_UNDEF_REPLACE                    = 0x00000020,
 
    RUBY_ECONV_UNDEF_HEX_CHARREF                = 0x00000030,
 
    RUBY_ECONV_DECORATOR_MASK                   = 0x0001ff00,
 
    RUBY_ECONV_NEWLINE_DECORATOR_MASK           = 0x00007f00,
 
    RUBY_ECONV_NEWLINE_DECORATOR_READ_MASK      = 0x00000f00,
 
    RUBY_ECONV_NEWLINE_DECORATOR_WRITE_MASK     = 0x00007000,
 
    RUBY_ECONV_UNIVERSAL_NEWLINE_DECORATOR      = 0x00000100,
 
    RUBY_ECONV_CRLF_NEWLINE_DECORATOR           = 0x00001000,
 
    RUBY_ECONV_CR_NEWLINE_DECORATOR             = 0x00002000,
 
    RUBY_ECONV_LF_NEWLINE_DECORATOR             = 0x00004000,
 
    RUBY_ECONV_XML_TEXT_DECORATOR               = 0x00008000,
 
    RUBY_ECONV_XML_ATTR_CONTENT_DECORATOR       = 0x00010000,
 
    RUBY_ECONV_STATEFUL_DECORATOR_MASK          = 0x00f00000,
 
    RUBY_ECONV_XML_ATTR_QUOTE_DECORATOR         = 0x00100000,
 
    RUBY_ECONV_DEFAULT_NEWLINE_DECORATOR        =
#if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32)
        RUBY_ECONV_CRLF_NEWLINE_DECORATOR,
#else
        0,
#endif
 
#define ECONV_ERROR_HANDLER_MASK                RUBY_ECONV_ERROR_HANDLER_MASK           
#define ECONV_INVALID_MASK                      RUBY_ECONV_INVALID_MASK                 
#define ECONV_INVALID_REPLACE                   RUBY_ECONV_INVALID_REPLACE              
#define ECONV_UNDEF_MASK                        RUBY_ECONV_UNDEF_MASK                   
#define ECONV_UNDEF_REPLACE                     RUBY_ECONV_UNDEF_REPLACE                
#define ECONV_UNDEF_HEX_CHARREF                 RUBY_ECONV_UNDEF_HEX_CHARREF            
#define ECONV_DECORATOR_MASK                    RUBY_ECONV_DECORATOR_MASK               
#define ECONV_NEWLINE_DECORATOR_MASK            RUBY_ECONV_NEWLINE_DECORATOR_MASK       
#define ECONV_NEWLINE_DECORATOR_READ_MASK       RUBY_ECONV_NEWLINE_DECORATOR_READ_MASK  
#define ECONV_NEWLINE_DECORATOR_WRITE_MASK      RUBY_ECONV_NEWLINE_DECORATOR_WRITE_MASK 
#define ECONV_UNIVERSAL_NEWLINE_DECORATOR       RUBY_ECONV_UNIVERSAL_NEWLINE_DECORATOR  
#define ECONV_CRLF_NEWLINE_DECORATOR            RUBY_ECONV_CRLF_NEWLINE_DECORATOR       
#define ECONV_CR_NEWLINE_DECORATOR              RUBY_ECONV_CR_NEWLINE_DECORATOR         
#define ECONV_LF_NEWLINE_DECORATOR              RUBY_ECONV_LF_NEWLINE_DECORATOR         
#define ECONV_XML_TEXT_DECORATOR                RUBY_ECONV_XML_TEXT_DECORATOR           
#define ECONV_XML_ATTR_CONTENT_DECORATOR        RUBY_ECONV_XML_ATTR_CONTENT_DECORATOR   
#define ECONV_STATEFUL_DECORATOR_MASK           RUBY_ECONV_STATEFUL_DECORATOR_MASK      
#define ECONV_XML_ATTR_QUOTE_DECORATOR          RUBY_ECONV_XML_ATTR_QUOTE_DECORATOR     
#define ECONV_DEFAULT_NEWLINE_DECORATOR         RUBY_ECONV_DEFAULT_NEWLINE_DECORATOR    
    RUBY_ECONV_PARTIAL_INPUT                    = 0x00020000,
 
    RUBY_ECONV_AFTER_OUTPUT                     = 0x00040000,
#define ECONV_PARTIAL_INPUT                     RUBY_ECONV_PARTIAL_INPUT 
#define ECONV_AFTER_OUTPUT                      RUBY_ECONV_AFTER_OUTPUT  
    RUBY_ECONV_FLAGS_PLACEHOLDER 
};
 
RBIMPL_SYMBOL_EXPORT_END()
 
#endif /* RUBY_INTERNAL_ENCODING_TRANSCODE_H */