ion_extractor.h

Go to the documentation of this file.

/*
 * Copyright 2012-2017 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.
 */
 
#ifndef ION_EXTRACTOR_H
#define ION_EXTRACTOR_H
 
#include "ion.h"
#include <stdbool.h>
 
#ifdef ION_EXTRACTOR_MAX_PATH_LENGTH_LIMIT
    #undef ION_EXTRACTOR_MAX_PATH_LENGTH_LIMIT
#endif
 
#ifdef ION_EXTRACTOR_MAX_NUM_PATHS_LIMIT
    #undef ION_EXTRACTOR_MAX_NUM_PATHS_LIMIT
#endif
 
#define ION_EXTRACTOR_MAX_PATH_LENGTH_LIMIT UINT16_MAX
 
#define ION_EXTRACTOR_MAX_NUM_PATHS_LIMIT UINT16_MAX
 
#ifdef ION_EXTRACTOR_MAX_PATH_LENGTH_DEFAULT
    #undef ION_EXTRACTOR_MAX_PATH_LENGTH_DEFAULT
#endif
 
#ifdef ION_EXTRACTOR_MAX_NUM_PATHS_DEFAULT
    #undef ION_EXTRACTOR_MAX_NUM_PATHS_DEFAULT
#endif
 
#define ION_EXTRACTOR_MAX_PATH_LENGTH_DEFAULT DEFAULT_WRITER_STACK_DEPTH
 
#define ION_EXTRACTOR_MAX_NUM_PATHS_DEFAULT 16
 
#ifndef ION_EXTRACTOR_MAX_PATH_LENGTH
    #define ION_EXTRACTOR_MAX_PATH_LENGTH ION_EXTRACTOR_MAX_PATH_LENGTH_DEFAULT
#else
    #if ION_EXTRACTOR_MAX_PATH_LENGTH > ION_EXTRACTOR_MAX_PATH_LENGTH_LIMIT
        #undef ION_EXTRACTOR_MAX_PATH_LENGTH
        #define ION_EXTRACTOR_MAX_PATH_LENGTH ION_EXTRACTOR_MAX_PATH_LENGTH_LIMIT
    #elif ION_EXTRACTOR_MAX_PATH_LENGTH < 1
        #undef ION_EXTRACTOR_MAX_PATH_LENGTH
        #define ION_EXTRACTOR_MAX_PATH_LENGTH ION_EXTRACTOR_MAX_PATH_LENGTH_DEFAULT
    #endif
#endif
 
#ifndef ION_EXTRACTOR_MAX_NUM_PATHS
    #define ION_EXTRACTOR_MAX_NUM_PATHS ION_EXTRACTOR_MAX_NUM_PATHS_DEFAULT
#else
    #if ION_EXTRACTOR_MAX_NUM_PATHS > ION_EXTRACTOR_MAX_NUM_PATHS_LIMIT
        #undef ION_EXTRACTOR_MAX_NUM_PATHS
        #define ION_EXTRACTOR_MAX_NUM_PATHS ION_EXTRACTOR_MAX_NUM_PATHS_LIMIT
    #elif ION_EXTRACTOR_MAX_NUM_PATHS < 1
        #undef ION_EXTRACTOR_MAX_NUM_PATHS
        #define ION_EXTRACTOR_MAX_NUM_PATHS ION_EXTRACTOR_MAX_NUM_PATHS_DEFAULT
    #endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint16_t ION_EXTRACTOR_SIZE;
 
typedef struct _ion_extractor_options {
    ION_EXTRACTOR_SIZE max_path_length;
 
    ION_EXTRACTOR_SIZE max_num_paths;
 
    bool match_relative_paths;
 
    bool match_case_insensitive;
 
} ION_EXTRACTOR_OPTIONS;
 
typedef struct _ion_extractor ION_EXTRACTOR;
 
typedef ION_EXTRACTOR *hEXTRACTOR;
 
typedef struct _ion_extractor_path_descriptor ION_EXTRACTOR_PATH_DESCRIPTOR;
 
typedef ION_EXTRACTOR_PATH_DESCRIPTOR *hPATH;
 
typedef int_fast16_t ION_EXTRACTOR_CONTROL;
 
static inline ION_EXTRACTOR_CONTROL ion_extractor_control_step_out(int n)
{
    return (ION_EXTRACTOR_CONTROL) n;
}
 
static inline ION_EXTRACTOR_CONTROL ion_extractor_control_next()
{
    return ion_extractor_control_step_out(0);
}
 
typedef iERR (*ION_EXTRACTOR_CALLBACK)(hREADER reader, hPATH matched_path, void *user_context,
                                       ION_EXTRACTOR_CONTROL *p_control);
 
ION_API_EXPORT iERR ion_extractor_open(hEXTRACTOR *extractor, ION_EXTRACTOR_OPTIONS *options);
 
ION_API_EXPORT iERR ion_extractor_path_create(hEXTRACTOR extractor, ION_EXTRACTOR_SIZE path_length,
                                              ION_EXTRACTOR_CALLBACK callback, void *user_context,
                                              hPATH *p_path);
 
ION_API_EXPORT iERR ion_extractor_path_append_field(hPATH path, ION_STRING *value);
 
ION_API_EXPORT iERR ion_extractor_path_append_ordinal(hPATH path, POSITION value);
 
ION_API_EXPORT iERR ion_extractor_path_append_wildcard(hPATH path);
 
ION_API_EXPORT iERR ion_extractor_path_create_from_ion(hEXTRACTOR extractor, ION_EXTRACTOR_CALLBACK callback,
                                                       void *user_context, BYTE *ion_data, SIZE ion_data_length,
                                                       hPATH *p_path);
 
ION_API_EXPORT iERR ion_extractor_match(hEXTRACTOR extractor, hREADER reader);
 
ION_API_EXPORT iERR ion_extractor_close(hEXTRACTOR extractor);
 
#ifdef __cplusplus
}
#endif
 
#endif //ION_EXTRACTOR_H