ion_reader.h

Go to the documentation of this file.

/*
 * Copyright 2009-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at:
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 */
 
//
// defines for the readers, common, text and binary
//
#ifndef ION_READER_H_
#define ION_READER_H_
#include "ion_types.h"
#include "ion_stream.h"
#ifdef __cplusplus
extern "C" {
#endif
 
typedef iERR (*ION_READER_CONTEXT_CALLBACK)(void *context, ION_COLLECTION *imports);
 
typedef struct _ion_reader_context_change_notifier {
    ION_READER_CONTEXT_CALLBACK notify;
 
    void *context;
 
} ION_READER_CONTEXT_CHANGE_NOTIFIER;
 
 
typedef struct _ion_reader_options
{
    BOOL return_system_values;
 
    int  new_line_char;
 
    SIZE max_container_depth;
 
    SIZE max_annotation_count;
 
    SIZE max_annotation_buffered;
 
    SIZE symbol_threshold;
 
    SIZE user_value_threshold;
 
    SIZE chunk_threshold;
 
    SIZE allocation_page_size;
 
    BOOL skip_character_validation;
 
    ION_CATALOG *pcatalog;
 
    decContext *decimal_context;
 
    ION_READER_CONTEXT_CHANGE_NOTIFIER context_change_notifier;
 
} ION_READER_OPTIONS;
 
//
// Ion Reader interface.  Takes a byte buffer and length which
// may have text or binary content, returns handle to a reader.
//
 
ION_API_EXPORT iERR ion_reader_open_buffer(hREADER *p_hreader
                                          ,BYTE *buffer
                                          ,SIZE buf_length
                                          ,ION_READER_OPTIONS *p_options);
 
ION_API_EXPORT iERR ion_reader_open_stream(hREADER *p_hreader
                                          ,void *handler_state
                                          ,ION_STREAM_HANDLER fn_input_handler
                                          ,ION_READER_OPTIONS *p_options);
 
ION_API_EXPORT iERR ion_reader_reset_stream(hREADER *p_hreader
                                           ,void *handler_state
                                           ,ION_STREAM_HANDLER fn_input_handler);
 
ION_API_EXPORT iERR ion_reader_reset_stream_with_length(hREADER *p_hreader
                                                       ,void *handler_state
                                                       ,ION_STREAM_HANDLER fn_input_handler
                                                       ,POSITION length);
 
ION_API_EXPORT iERR ion_reader_open                    (hREADER *p_hreader
                                                       ,ION_STREAM *p_stream
                                                       ,ION_READER_OPTIONS *p_options);
ION_API_EXPORT iERR ion_reader_get_catalog             (hREADER hreader, hCATALOG *p_hcatalog);
 
ION_API_EXPORT iERR ion_reader_seek                (hREADER  hreader
                                                   ,POSITION offset
                                                   ,SIZE     length);
ION_API_EXPORT iERR ion_reader_set_symbol_table    (hREADER   hreader
                                                   ,hSYMTAB   hsymtab);
ION_API_EXPORT iERR ion_reader_get_value_offset    (hREADER   hreader
                                                   ,POSITION *p_offset);
 
ION_API_EXPORT iERR ion_reader_get_value_position  (hREADER   hreader
                                                   ,int64_t   *p_offset
                                                   ,int32_t   *p_line
                                                   ,int32_t   *p_col_offset);
 
ION_API_EXPORT iERR ion_reader_get_value_length    (hREADER  hreader
                                                   ,SIZE   *p_length);
ION_API_EXPORT iERR ion_reader_get_symbol_table    (hREADER   hreader
                                                   ,hSYMTAB  *p_hsymtab);
ION_API_EXPORT iERR ion_reader_next                (hREADER hreader, ION_TYPE *p_value_type);
ION_API_EXPORT iERR ion_reader_step_in             (hREADER hreader);
ION_API_EXPORT iERR ion_reader_step_out            (hREADER hreader);
ION_API_EXPORT iERR ion_reader_get_depth           (hREADER hreader, SIZE *p_depth);
 
ION_API_EXPORT iERR ion_reader_get_type            (hREADER hreader, ION_TYPE *p_value_type);
ION_API_EXPORT iERR ion_reader_has_any_annotations (hREADER hreader, BOOL *p_has_any_annotations);
ION_API_EXPORT iERR ion_reader_has_annotation      (hREADER hreader, iSTRING annotation, BOOL *p_annotation_found);
ION_API_EXPORT iERR ion_reader_is_null             (hREADER hreader, BOOL *p_is_null);
ION_API_EXPORT iERR ion_reader_is_in_struct        (hREADER preader, BOOL *p_is_in_struct);
ION_API_EXPORT iERR ion_reader_get_field_name      (hREADER hreader, iSTRING p_str);
ION_API_EXPORT iERR ion_reader_get_field_name_symbol(hREADER hreader, ION_SYMBOL **p_psymbol);
ION_API_EXPORT iERR ion_reader_get_annotations     (hREADER hreader, iSTRING p_strs, SIZE max_count, SIZE *p_count);
ION_API_EXPORT iERR ion_reader_get_annotation_symbols(hREADER hreader, ION_SYMBOL *p_symbols, SIZE max_count, SIZE *p_count);
ION_API_EXPORT iERR ion_reader_get_annotation_count(hREADER hreader, SIZE *p_count);
ION_API_EXPORT iERR ion_reader_get_an_annotation   (hREADER hreader, int idx, iSTRING p_strs);
ION_API_EXPORT iERR ion_reader_get_an_annotation_symbol(hREADER hreader, int idx, ION_SYMBOL *p_symbol);
ION_API_EXPORT iERR ion_reader_read_null           (hREADER hreader, ION_TYPE *p_value);
ION_API_EXPORT iERR ion_reader_read_bool           (hREADER hreader, BOOL *p_value);
 
ION_API_EXPORT iERR ion_reader_read_int            (hREADER hreader, int *p_value);
 
ION_API_EXPORT iERR ion_reader_read_int32            (hREADER hreader, int32_t *p_value);
 
ION_API_EXPORT iERR ion_reader_read_int64          (hREADER hreader, int64_t *p_value);
 
ION_API_EXPORT iERR ion_reader_read_ion_int        (hREADER hreader, ION_INT *p_value);
 
ION_API_EXPORT iERR ion_reader_read_long           (hREADER hreader, long *p_value);
ION_API_EXPORT iERR ion_reader_read_double         (hREADER hreader, double *p_value);
 
ION_API_EXPORT iERR ion_reader_read_decimal        (hREADER hreader, decQuad *p_value);
ION_API_EXPORT iERR ion_reader_read_ion_decimal    (hREADER hreader, ION_DECIMAL *p_value);
 
ION_API_EXPORT iERR ion_reader_read_timestamp      (hREADER hreader, iTIMESTAMP p_value);
 
ION_API_EXPORT iERR ion_reader_read_ion_symbol(hREADER hreader, ION_SYMBOL *p_symbol);
 
ION_API_EXPORT iERR ion_reader_get_string_length   (hREADER hreader, SIZE *p_length); // note this may require the string value to be loaded in memory
ION_API_EXPORT iERR ion_reader_read_string         (hREADER hreader, iSTRING p_value);
ION_API_EXPORT iERR ion_reader_read_partial_string (hREADER hreader, BYTE *p_buf, SIZE buf_max, SIZE *p_length);
 
// TODO: move this to get_value_size, get_value_bytes, get_value_chuck that can read
//       string, long int, decimal and timestamp values in addition to blob and clob
ION_API_EXPORT iERR ion_reader_get_lob_size          (hREADER hreader, SIZE *p_length); // this may require the lob value to be loaded in memroy
ION_API_EXPORT iERR ion_reader_read_lob_bytes        (hREADER hreader, BYTE *p_buf, SIZE buf_max, SIZE *p_length);
ION_API_EXPORT iERR ion_reader_read_lob_partial_bytes(hREADER hreader, BYTE *p_buf, SIZE buf_max, SIZE *p_length);
 
ION_API_EXPORT iERR ion_reader_get_position          (hREADER hreader, int64_t *p_bytes, int32_t *p_line, int32_t *p_offset);
 
ION_API_EXPORT iERR ion_reader_close(hREADER hreader);
#ifdef __cplusplus
}
#endif
 
#endif