PDDefines.h

Go to the documentation of this file.

//
// PDDefines.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_PDDefines_h
#define INCLUDED_PDDefines_h

#include <sys/types.h>

#define PD_SUPPORT_ZLIB

#define PD_SUPPORT_CRYPTO

// #define DEBUG

#define PD_WARNINGS

//#define PD_NOTICES

#define PD_ASSERTS

//#define PD_DEBUG_TWINSTREAM_ASSERT_OBJECTS

//#define DEBUG_PARSER_PRINT_XREFS

//#define DEBUG_PARSER_CHECK_XREFS

//#define DEBUG_SCANNER_SYMBOLS

#define DEBUG_PDTYPES

//#define DEBUG_PD_RELEASES

//#define DEBUG_PD_STRINGS


//#define DEBUG_PD_LEAKS

/*
 This forces DEBUG_PD_RELEASES to be enabled if DEBUG_PD_LEAKS is set.
 */
#if defined(DEBUG_PD_LEAKS) && !defined(DEBUG_PD_RELEASES)
#   warning Forcing DEBUG_PD_RELEASES as DEBUG_PD_LEAKS is set.
#   define DEBUG_PD_RELEASES
#endif

#ifndef __deprecated
#    warning __deprecated macro was not defined; consider including <sys/cdefs.h>
#    define __deprecated 
#endif

#define PD_DEPRECATED(introduce_version, deprecate_version) __deprecated

typedef long                 PDInteger;

#define PDIntegerFromString atol

typedef float                PDReal;

#define PDRealFromString atof

#ifdef bool
typedef bool                 PDBool;
#else
typedef unsigned char        PDBool;
#endif

typedef size_t               PDSize;

#define PDSizeFromString     atol

typedef long long            PDOffset;

#define PDOffsetFromString   atoll

typedef struct PDPoint       PDPoint;
struct PDPoint {
    PDReal x, y;
};

typedef struct PDRect        PDRect;
struct PDRect {
    PDPoint a, b;
};

#define PDRectFromOSRect(osr) (PDRect) {{osr.origin.x, osr.origin.y}, {osr.origin.x+osr.size.width, osr.origin.y+osr.size.height}}

#define PDRectToOSRect(rect) {{rect.a.x, rect.a.y}, {rect.b.x-rect.a.x, rect.b.y-rect.a.y}}

//#define PDRectReadFromArrayString(rect, str) sscanf(str, "[%f %f %f %f]", &rect.a.x, &rect.a.y, &rect.b.x, &rect.b.y)

//#define PDRectWriteToArrayString(rect, str) sprintf(str, "[%f %f %f %f]", rect.a.x, rect.a.y, rect.b.x, rect.b.y)

typedef const char         **PDID;

typedef void (*PDDeallocator)(void *ob);

extern void PDNOP(void*);

typedef void (*PDSynchronizer)(void *parser, void *object, const void *syncInfo);

typedef union PDType *PDTypeRef;

typedef struct pd_stack      *pd_stack;

typedef struct PDArray      *PDArrayRef;

typedef void (*PDHashIterator)(char *key, void *value, void *userInfo, PDBool *shouldStop);

typedef struct PDDictionary *PDDictionaryRef;

typedef struct PDDictionaryStack *PDDictionaryStackRef;

typedef struct PDFontDictionary *PDFontDictionaryRef;

typedef struct PDFont *PDFontRef;

typedef struct PDCMap *PDCMapRef;

typedef enum {
    pd_crypto_method_none  = 0,
    pd_crypto_method_rc4   = 1,
    pd_crypto_method_aesv2 = 2,
} pd_crypto_method;

typedef enum {
    pd_auth_event_none    = 0,
    pd_auth_event_docopen = 1,
} pd_auth_event;

typedef struct pd_crypto    *pd_crypto;

typedef struct PDStaticHash *PDStaticHashRef;

typedef struct PDSplayTree *PDSplayTreeRef;

struct PDSelection {
    PDInteger page;
    PDRect position;
    const char *text;
};

typedef struct PDSelection *PDSelectionRef;

typedef PDBool (*PDTextSearchOperatorFunc)(PDSelectionRef selection);

typedef struct PDObject *PDObjectRef;

typedef struct PDPage *PDPageRef;

typedef struct PDParserAttachment *PDParserAttachmentRef;

typedef struct PDObjectStream *PDObjectStreamRef;

typedef struct PDContentStream *PDContentStreamRef;

typedef enum {
    PDOperatorStateIndependent = 0, 
    PDOperatorStatePush        = 1, 
    PDOperatorStatePop         = 2, 
    PDOperatorStateSeek        = 3, 
} PDOperatorState;

typedef PDOperatorState (*PDContentOperatorFunc)(PDContentStreamRef cs, void *userInfo, PDArrayRef args, pd_stack inState, pd_stack *outState);

typedef enum {
    PDInstanceTypeUnset     =-2,    
    PDInstanceTypeUnknown   =-1,    
    PDInstanceTypeNull      = 0,    
    PDInstanceTypeNumber    = 1,    
    PDInstanceTypeString    = 2,    
    PDInstanceTypeArray     = 3,    
    PDInstanceTypeDict      = 4,    
    PDInstanceTypeRef       = 5,    
    PDInstanceTypeObj       = 6,    
    PDInstanceTypeParser    = 7,
    PDInstanceTypePipe      = 8,
    PDInstanceTypeScanner   = 9,
    PDInstanceTypeCStream   = 10,   
    PDInstanceTypeOStream   = 11,   
    PDInstanceTypeOperator  = 12,
    PDInstanceTypePage      = 13,
    PDInstanceTypeParserAtt = 14,
    PDInstanceTypeTree      = 15,   
    PDInstanceTypeState     = 16,   
    PDInstanceTypeSFilter   = 17,   
    PDInstanceTypeTask      = 18,   
    PDInstanceType2Stream   = 19,
    PDInstanceTypeXTable    = 20,   
    PDInstanceTypeCSOper    = 21,   
    PDInstanceTypeFontDict  = 22,   
    PDInstanceTypeFont      = 23,   
    PDInstanceTypeCMap      = 24,   
    PDInstanceTypePSExec    = 25,   
    PDInstanceTypeDictStack = 26,   
    //
    PDInstanceType__SIZE    = 27,
} PDInstanceType;

typedef PDInteger (*PDInstancePrinter)(void *inst, char **buf, PDInteger offs, PDInteger *cap);

extern PDInstancePrinter PDInstancePrinters[];

typedef enum {
    PDObjectTypeNull        = 0,    
    PDObjectTypeUnknown     = 1,    
    PDObjectTypeBoolean,            
    PDObjectTypeInteger,            
    PDObjectTypeReal,               
    PDObjectTypeName,               
    PDObjectTypeString,             
    PDObjectTypeArray,              
    PDObjectTypeDictionary,         
    PDObjectTypeStream,             
    PDObjectTypeReference,          
    PDObjectTypeSize,               
} PDObjectType;

typedef enum {
    PDObjectClassRegular    = 1,    
    PDObjectClassCompressed = 2,    
    PDObjectClassTrailer    = 3,    
} PDObjectClass;

typedef struct PDReference  *PDReferenceRef;

typedef enum {
    PDStringTypeEscaped = 1,        
    PDStringTypeHex     = 2,        
    PDStringTypeBinary  = 3,        
    PDStringTypeName    = 4,        
} PDStringType;

typedef enum {
    PDStringEncodingDefault = 0,    
    PDStringEncodingASCII = 1,      
    PDStringEncodingUTF8 = 2,       
    PDStringEncodingUTF16BE = 3,    
    PDStringEncodingUTF16LE = 4,    
    PDStringEncodingUTF32 = 5,      
    PDStringEncodingMacRoman = 6,   
    PDStringEncodingEUCJP = 7,      
    PDStringEncodingSHIFTJIS = 8,   
    PDStringEncodingISO8859_1 = 9,  
    PDStringEncodingISO8859_2 = 10, 
    PDStringEncodingCP1251 = 11,    
    PDStringEncodingCP1252 = 12,    
    PDStringEncodingCP1253 = 13,    
    PDStringEncodingCP1254 = 14,    
    PDStringEncodingCP1250 = 15,    
    PDStringEncodingISO2022JP = 16, 
    __PDSTRINGENC_END = 16,         
    
    PDStringEncodingCustom = 998,   
    PDStringEncodingUndefined = 999,
} PDStringEncoding;

extern const char *PDStringEncodingToIconvName(PDStringEncoding enc);

typedef struct PDNumber  *PDNumberRef;

typedef struct PDString  *PDStringRef;

typedef struct PDPipe       *PDPipeRef;

typedef struct PDTask       *PDTaskRef;

typedef enum {
    PDFTypePage = 1,            
    PDFTypePages,               
    PDFTypeCatalog,             
    PDFTypeAnnot,               
    PDFTypeFont,                
    PDFTypeFontDescriptor,      
    PDFTypeAction,              
    
    _PDFTypeCount,              
} PDFType;

#define kPDFTypeStrings \
    NULL, "/Page", "/Pages", "/Catalog", "/Annot", "/Font", "/FontDescriptor", "/Action"

typedef enum {
    PDPropertyObjectId      = 1,
    PDPropertyRootObject,       
    PDPropertyInfoObject,       
    PDPropertyPDFType,          
    PDPropertyPage,             
} PDPropertyType;

typedef enum {
    PDTaskFailure   = -1,       
    PDTaskDone      =  0,       
    PDTaskSkipRest  =  1,       
    PDTaskUnload    =  2,       
} PDTaskResult;

typedef PDTaskResult (*PDTaskFunc)(PDPipeRef pipe, PDTaskRef task, PDObjectRef object, void *info);

typedef struct PDParser     *PDParserRef;

typedef struct PDCatalog    *PDCatalogRef;

typedef struct PDTwinStream *PDTwinStreamRef;

typedef enum {
    PDTwinStreamReadWrite,      
    PDTwinStreamRandomAccess,   
    PDTwinStreamReversed,       
} PDTwinStreamMethod;

typedef enum {
    PDPredictorNone = 1,        
    PDPredictorTIFF2 = 2,       
    PDPredictorPNG_NONE = 10,   
    PDPredictorPNG_SUB = 11,    
    PDPredictorPNG_UP = 12,     
    PDPredictorPNG_AVG = 13,    
    PDPredictorPNG_PAE = 14,    
    PDPredictorPNG_OPT = 15,    
} PDPredictorType;

typedef struct PDStreamFilter *PDStreamFilterRef;

typedef struct PDEnv        *PDEnvRef;

typedef struct PDState      *PDStateRef;

typedef struct PDOperator   *PDOperatorRef;

typedef enum {
    PDOperatorPushState = 1,    
    PDOperatorPushWeakState,    
    PDOperatorPopState,         
    PDOperatorPopVariable,      
    PDOperatorPopValue,         
    PDOperatorPushEmptyString,  
    PDOperatorPushResult,       
    //PDOperatorAppendResult,     ///< Appends current symbol to last result on stack
    //PDOperatorPushContent,      ///< Pushes everything from the point where the state was entered to current offset to results
    PDOperatorPushComplex,      
    PDOperatorStoveComplex,     
    PDOperatorPullBuildVariable,
    PDOperatorPushbackSymbol,   
    PDOperatorPushbackValue,    
    PDOperatorPopLine,          
    PDOperatorReadToDelimiter,  
    PDOperatorMark,             
    PDOperatorPushMarked,       
    PDOperatorNOP,              
    // debugging
    PDOperatorBreak,            
} PDOperatorType;

typedef struct PDScanner    *PDScannerRef;

typedef void(*PDScannerBufFunc)(void *info, PDScannerRef scanner, char **buf, PDInteger *size, PDInteger req);

typedef void(*PDScannerPopFunc)(PDScannerRef scanner);

#include "PDType.h"

#endif