PDXTable.h

Go to the documentation of this file.

//
// PDXTable.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_PDXTable_h
#define INCLUDED_PDXTable_h

#include <sys/types.h>
#include "PDDefines.h"

typedef enum {
    PDXTableFormatText   = 0, 
    PDXTableFormatBinary = 1, 
} PDXFormat;

enum {
    PDXTypeFreed    = 0,    
    PDXTypeUsed     = 1,    
    PDXTypeComp     = 2,    
};

typedef unsigned char PDXType;      
//typedef u_int32_t PDXOffsetType;    ///< The offset representation of an XREF entry.
//typedef unsigned char PDXGenType;   ///< The generation / index representation of an XREF entry.

//#define PDXTypeSize     1   ///< The size of the XREF type. Note: this must not be changed
//#define PDXOffsSize     4   ///< The size of the offset type. Note: changing this requires updating PDXGet/SetOffsetForID
//#define PDXGenSize      1   ///< The generation number / object index type size. Note: this must not be changed

//#define PDXTypeAlign    0                               ///< The alignment of the XREF type inside its XREF field
//#define PDXOffsAlign    PDXTypeSize                     ///< The alignment of the offset type inside its XREF field
//#define PDXGenAlign     (PDXOffsAlign + PDXOffsSize)    ///< The alignment of the generation number inside its XREF field
//#define PDXWidth        (PDXGenAlign + PDXGenSize)      ///< The width of an XREF field

// Why can't I make this use the quoted value of the #defines above...?
//#define PDXWEntry       "[ 1 4 1 ]" ///< The PDF array expression for the sizes above (a [ followed by a the numbers in order followed by a ])

struct PDXTable {
    PDInteger   allocx;
    PDInteger   obid;       
    char       *xrefs;      
    
    PDXFormat   format;     
    PDBool      linearized; 
    PDSize      cap;        
    PDSize      count;      
    PDSize      pos;        
    
    PDXTableRef prev;       
    PDXTableRef next;       
    
    PDOffset    offsCap;    
    
    PDArrayRef  w;          
    PDInteger  *nextOb;     
    
    unsigned char typeSize;   
    unsigned char offsSize;   
    unsigned char genSize;    
    unsigned char typeAlign;  
    unsigned char offsAlign;  
    unsigned char genAlign;   
    unsigned char width;      
};

extern PDOffset PDXTableGetOffsetForID(PDXTableRef table, PDInteger obid);

extern void PDXTableSetOffsetForID(PDXTableRef table, PDInteger obid, PDOffset offset);

#define PDXTableGetTypeForID(table, id)         (PDXType)((table->xrefs)[id*table->width])
//extern PDInteger PDXTableGetTypeForID(PDXTableRef table, PDInteger obid);

#define PDXTableSetTypeForID(table, id, t)    *(PDXType*)&((table->xrefs)[id*table->width]) = t
//extern void PDXTableSetTypeForID(PDXTableRef table, PDInteger obid, PDInteger type);

extern PDInteger PDXTableGetGenForID(PDXTableRef table, PDInteger obid);
//#define PDXGetGenForID(xrefs, id)         (PDXGenType)((xrefs)[PDXGenAlign+id*PDXWidth])

//static inline PDXGenType _PDXGetGenForID(char *xrefs, PDInteger obid)
//{
//    return (PDXGenType)((xrefs)[PDXGenAlign+obid*PDXWidth]);
//}

extern void PDXTableSetGenForID(PDXTableRef table, PDInteger obid, PDInteger gen);
//#define PDXSetGenForID(xrefs, id, gen)   *(PDXGenType*)&((xrefs)[PDXGenAlign+id*PDXWidth]) = gen

// Get the type for the given object in the table.
// 
// @param xtable The PDXTableRef instance
// @param id The object ID.
// */
//#define PDXTableGetTypeForID(xtable, id)       PDXGetTypeForID(xtable->xrefs, id)
//
// Set the type for the given object in the table.
// 
// @param xtable The PDXTableRef instance
// @param id The object ID.
// @param t The new type.
// */
//#define PDXTableSetTypeForID(xtable, id, t)     PDXSetTypeForID(xtable->xrefs, id, t)
//
// Get the offset for the given object in the table.
// 
// @param xtable The PDXTableRef instance
// @param id The object ID.
// */
//#define PDXTableGetOffsetForID(xtable, id)     PDXGetOffsetForID(xtable->xrefs, id)
//
// Get the generation number or object stream index for the given object in the table.
// 
// @param xtable The PDXTableRef instance
// @param id The object ID.
// */
//#define PDXTableGetGenForID(xtable, id)        PDXGetGenForID(xtable->xrefs, id)

#define PDXTableIsIDFree(xtable, id)        (PDXTypeFreed == PDXTableGetTypeForID(xtable, id))

// Set the offset for the object with the given ID to the given offset in the XREF table.
// 
// @param xtable The PDX table instance.
// @param id The object ID.
// @param offs The new offset.
// */
//#define PDXTableSetOffset(xtable, id, offs) PDXSetOffsetForID(xtable->xrefs, id, (PDXOffsetType)offs)

extern PDBool PDXTableFetchXRefs(PDParserRef parser);

extern PDBool PDXTablePassoverXRefEntry(PDParserRef parser, pd_stack stack, PDBool includeTrailer);

extern PDBool PDXTableInsert(PDParserRef parser);

extern PDArrayRef PDXTableWEntry(PDXTableRef table);

extern void PDXTableSetSizes(PDXTableRef table, unsigned char typeSize, unsigned char offsSize, unsigned char genSize);

extern void PDXTableGrow(PDXTableRef table, PDSize cap);

extern PDSize PDXTableDetermineObjectSize(PDXTableRef table, PDInteger obid);

#endif