PDTwinStream.h

Go to the documentation of this file.

//
// PDTwinStream.h
//
// Copyright (c) 2012 - 2015 Karl-Johan Alm (http://github.com/kallewoof)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
#ifndef INCLUDED_PDTwinStream_h
#define INCLUDED_PDTwinStream_h

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


extern PDTwinStreamRef PDTwinStreamCreate(FILE *fi, FILE *fo);


extern void PDTWinStreamSetMethod(PDTwinStreamRef ts, PDTwinStreamMethod method);

extern PDScannerRef PDTwinStreamGetScanner(PDTwinStreamRef ts);

extern PDScannerRef PDTwinStreamSetupScannerWithState(PDTwinStreamRef ts, PDStateRef state);

#define PDTwinStreamGetInputOffset(str)  (str->offsi + str->cursor)

#define PDTwinStreamGetOutputOffset(str) (str->offso)


extern void PDTwinStreamGrowInputBuffer(void *ts, PDScannerRef scanner, char **buf, PDInteger *size, PDInteger req);

extern void PDTwinStreamGrowInputBufferReversed(void *ts, PDScannerRef scanner, char **buf, PDInteger *size, PDInteger req);

extern void PDTwinStreamDisallowGrowth(void *ts, PDScannerRef scanner, char **buf, PDInteger *size, PDInteger req);

extern void PDTwinStreamSeek(PDTwinStreamRef ts, PDSize position);

extern void PDTwinStreamAdvance(PDTwinStreamRef ts, PDSize bytes);

extern PDSize PDTwinStreamFetchBranch(PDTwinStreamRef ts, PDSize position, PDInteger bytes, char **buf);

extern void PDTwinStreamCutBranch(PDTwinStreamRef ts, char *buf);


// all commit operations are subject to heap realignment; any scanners except the master scanner (stream->scanner) must be discarded 
// method must be ReadWrite; this is seldom checked; behavior is undefined if this is not the case, and the resulting PDF will most certainly not be OK

extern void PDTWinStreamPassthroughContent(PDTwinStreamRef ts);

extern void PDTwinStreamDiscardContent(PDTwinStreamRef ts);

extern void PDTwinStreamInsertContent(PDTwinStreamRef ts, PDSize bytes, const char *content);

extern void PDTwinStreamPrune(PDTwinStreamRef ts, PDOffset mark);

extern PDScannerRef PDTwinStreamCreateScanner(PDTwinStreamRef ts, PDStateRef state);


#ifdef PD_DEBUG_TWINSTREAM_ASSERT_OBJECTS

extern void PDTwinStreamReassert(PDTwinStreamRef ts, PDOffset offset, char *expect, PDInteger len);
#endif

#endif