ntar.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005, Condor Engineering, Inc. 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions 
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright 
 * notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the following disclaimer in the 
 * documentation and/or other materials provided with the distribution. 
 * 3. Neither the name of the Company (Condor Engineering, Inc) nor the
 * names of its contributors may be used to endorse or promote products 
 * derived from this software without specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */

/*
 * Author: Gianluca Varenni <gianluca.varenni@gmail.com>
 */

#ifndef __NTAR_09443049285795464587845827
#define __NTAR_09443049285795464587845827


#include <stdio.h>
#include "block_headers.h"

#ifdef __cplusplus
extern "C" {
#endif

#define NTAR_SUCCESS                    0   
#define NTAR_FAILURE                    1   
#define NTAR_FAILURE_INVALID_ID         2   
#define NTAR_FAILURE_FILENOTFOUND       3   
#define NTAR_FAILURE_FILEEXISTS         4   
#define NTAR_FAILURE_CREATEFILEFAILED   5   
#define NTAR_FAILURE_NOMEM              6   
#define NTAR_FAILURE_SECTIONNOTCLOSED   7   
#define NTAR_FAILURE_WRITEONREADFILE    8   
#define NTAR_FAILURE_IOWRITE            9   
#define NTAR_FAILURE_BLOCKNOTCLOSED     10  
#define NTAR_FAILURE_IOREAD             11  
#define NTAR_FAILURE_EOF                12  
#define NTAR_FAILURE_INVALIDFILE        13  
#define NTAR_FAILURE_MALFORMED_BLOCK    14  
#define NTAR_FAILURE_NOMOREBLOCKS       15  
#define NTAR_FAILURE_BLOCKDATAUNREAD    16  
#define NTAR_FAILURE_SMALLBUFFER        17  
#define NTAR_FAILURE_BLOCKDATANOTSET    18  
#define NTAR_FAILURE_DUPPTR             19  
#define NTAR_FAILURE_ASCIIDLFILE        20  
#define NTAR_FAILURE_BLOCKTRAILERMISMATCH 21    
#define NTAR_FAILURE_ACCESSDENIED       22  
#define NTAR_FAILURE_BADFILEDESCRIPTOR  23  
#define NTAR_FAILURE_INVALIDPARAMETER   24  
#define NTAR_FAILURE_TOOMANYOPENFILES   25  
#define NTAR_FAILURE_DISKFULL           26  
#define NTAR_FAILURE_UNKNOWNERRNO       27  

#define NTAR_FILEMODE_WRITE             0   
#define NTAR_FILEMODE_READ              1   
#define NTAR_FILEMODE_CREATE            2   
#define NTAR_FILEMODE_APPEND            3   

#define NTAR_OPEN_WRITE         "w"         
#define NTAR_OPEN_READ          "r"         
#define NTAR_OPEN_CREATE        "c"         
#define NTAR_OPEN_APPEND        "a"         


typedef struct _ntar_option
{
    struct _ntar_option *next;          
    u_int16 code;                       
    void *data;                         
}
    ntar_option;

typedef struct _ntar_block_handle ntar_block_handle;

typedef struct _ntar_section_handle ntar_section_handle;

typedef struct _ntar_file_handle ntar_file_handle;

typedef int (*ntar_write_handler)(void *handle, void* buffer, size_t size);

typedef int (*ntar_read_handler)(void *handle, void* buffer, size_t size, size_t *read_bytes);

typedef int (*ntar_seek_handler)(void *handle, ntar_foff new_position, int origin, ntar_foff *pold_position);

typedef struct _ntar_file_handlers
{
    ntar_read_handler read_handler;     
    ntar_write_handler write_handler;   

    ntar_seek_handler seek_handler;     

    void *handle;
}
    ntar_file_handlers;

/* NOTE: we include the plugins only here because the plugins need 
         the definitions of all the ntar structures. If we include
         the header at the beginning of the file, the definition of
         _NTAR_H_xxxxxx will be already there, but the structures will
         not be declared, yet.
*/
#include "plugins.h"
    
int ntar_open(char* filename, char* flags, ntar_file_handle** pfile_handle);

int ntar_open_by_handlers(ntar_file_handlers file_handlers, char* flags, ntar_file_handle** pfile_handle);

int ntar_close(ntar_file_handle* file_handle);

int ntar_create_section(ntar_file_handle* file_handle, ntar_section_handle** psection_handle);

int ntar_close_section(ntar_section_handle* section_handle);

int ntar_add_section_option(ntar_section_handle* section_handle, ntar_option *option);

int ntar_create_block(ntar_section_handle* section_handle, u_int32 block_type, void *data, ntar_block_handle** pblock_handle);

int ntar_close_block(ntar_block_handle* block_handle);

int ntar_add_block_option(ntar_block_handle* block_handle, ntar_option *option);

int ntar_get_next_section(ntar_file_handle* file_handle, ntar_section_handle** psection_handle);

int ntar_get_previous_section(ntar_file_handle* file_handle, ntar_section_handle** psection_handle);

int ntar_get_section_options(ntar_section_handle* section_handle, ntar_option **options);

int ntar_get_next_block(ntar_section_handle* section_handle, ntar_block_handle** pblock_handle);

int ntar_get_previous_block(ntar_section_handle* section_handle, ntar_block_handle** pblock_handle);

int ntar_get_block_type(ntar_block_handle* block_handle, u_int32 *pblock_type);

int ntar_get_block_data(ntar_block_handle* block_handle, void** data);

int ntar_get_block_options(ntar_block_handle* block_handle, ntar_option **options);

int ntar_getversion(char* buffer, u_int32 *pbuffer_size);

#ifdef __cplusplus
}
#endif


#endif /* __NTAR_09443049285795464587845827 */

---

NTAR documentation. Copyright (c) 2004 - 2005 Condor Engineering, Inc. All rights reserved.