scbstream.h

Go to the documentation of this file.

#ifndef SCBSTREAM_H_
#define SCBSTREAM_H_

/*
 * File Name  : scbstream.h
 * 
 * Description: Scribble library stream definition
 */

/*
 * This file is part of liberscribble.
 *
 * liberscribble is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * liberscribble is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */
 

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

// system include files, between < >
#include <glib.h>

// ereader include files, between < >

// local include files, between " "

G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------- 


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------  

// scribble stream, it acts like the stl stream
typedef struct _ScbStream
{
    int       offset;  // offset of the operation pointer
    int       size;    // size of the stream
    void      *buffer; // pointer to the buffer
} ScbStream;

typedef ScbStream * ScbStreamPtr;


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------


//============================================================================
// Public Functions
//============================================================================

// create a scb stream
ScbStreamPtr erscribble_create_stream(const int size);

// release a scb stream
void erscribble_free_stream(ScbStreamPtr stream, gboolean is_free_buffer);

// read from the stream
gboolean erscribble_read_stream(ScbStreamPtr stream, void *data, const int length);

// write to the stream
gboolean erscribble_write_stream(ScbStreamPtr stream, const void *data, const int length);

// reset the offset
void erscribble_reset_offset(ScbStreamPtr stream);


G_END_DECLS

#endif