/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * The contents of this file are subject to the Netscape Public License * Version 1.0 (the "NPL"); you may not use this file except in * compliance with the NPL. You may obtain a copy of the NPL at * http://www.mozilla.org/NPL/ * * Software distributed under the NPL is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL * for the specific language governing rights and limitations under the * NPL. * * The Initial Developer of this code under the NPL is Netscape * Communications Corporation. Portions created by Netscape are * Copyright (C) 1998 Netscape Communications Corporation. All Rights * Reserved. */ /* * Basic APIs for streaming typelib structures to/from disk. */ #ifndef __xpt_xdr_h__ #define __xpt_xdr_h__ #include #include #include #include "xpt_struct.h" PR_BEGIN_EXTERN_C typedef struct XPTState XPTState; typedef struct XPTDatapool XPTDatapool; typedef struct XPTCursor XPTCursor; extern XPT_PUBLIC_API(PRBool) XPT_DoString(XPTCursor *cursor, XPTString **strp); extern XPT_PUBLIC_API(PRBool) XPT_DoStringInline(XPTCursor *cursor, XPTString **strp); extern XPT_PUBLIC_API(PRBool) XPT_DoCString(XPTCursor *cursor, char **strp); extern XPT_PUBLIC_API(PRBool) XPT_DoIdentifier(XPTCursor *cursor, char **identp); extern XPT_PUBLIC_API(PRBool) XPT_DoIID(XPTCursor *cursor, nsID *iidp); extern XPT_PUBLIC_API(PRBool) XPT_Do64(XPTCursor *cursor, PRInt64 *u64p); extern XPT_PUBLIC_API(PRBool) XPT_Do32(XPTCursor *cursor, uint32 *u32p); extern XPT_PUBLIC_API(PRBool) XPT_Do16(XPTCursor *cursor, uint16 *u16p); extern XPT_PUBLIC_API(PRBool) XPT_Do8(XPTCursor *cursor, uint8 *u8p); /* * When working with bitfields, use the DoBits call with a uint8. * Only the appropriate number of bits are manipulated, so when * you're decoding you probably want to ensure that the uint8 is pre-zeroed. * When you're done sending bits along, use * XPT_FlushBits to make sure that you don't eat a leading bit from the * next structure. (You should probably be writing full bytes' worth of bits * anyway, and zeroing out the bits you don't use, but just to be sure...) */ extern XPT_PUBLIC_API(PRBool) XPT_DoBits(XPTCursor *cursor, uint8 *u8p, int nbits); #define XPT_DO_BITS(curs, field, width, scr) (PR_TRUE) /* returns the number of bits skipped, which should be 0-7 */ extern XPT_PUBLIC_API(int) XPT_FlushBits(XPTCursor *cursor); extern XPT_PUBLIC_API(PRBool) XPT_DoHeader(XPTCursor *cursor, XPTHeader **headerp); typedef enum { XPT_ENCODE, XPT_DECODE } XPTMode; typedef enum { XPT_HEADER = 0, XPT_DATA = 1 } XPTPool; struct XPTState { XPTMode mode; uint32 data_offset; uint32 next_cursor[2]; XPTDatapool *pool; }; struct XPTDatapool { PLHashTable *offset_map; char *data; uint32 count; uint32 allocated; }; struct XPTCursor { XPTState *state; XPTPool pool; uint32 offset; uint8 bits; }; extern XPT_PUBLIC_API(XPTState *) XPT_NewXDRState(XPTMode mode, char *data, uint32 len); extern XPT_PUBLIC_API(PRBool) XPT_MakeCursor(XPTState *state, XPTPool pool, uint32 len, XPTCursor *cursor); extern XPT_PUBLIC_API(PRBool) XPT_SeekTo(XPTCursor *cursor, uint32 offset); extern XPT_PUBLIC_API(void) XPT_DestroyXDRState(XPTState *state); /* Set file_length based on the data used in the state. (Only ENCODE.) */ extern XPT_PUBLIC_API(PRBool) XPT_UpdateFileLength(XPTState *state); extern XPT_PUBLIC_API(void) XPT_GetXDRData(XPTState *state, XPTPool pool, char **data, uint32 *len); /* set or get the data offset for the state, depending on mode */ extern XPT_PUBLIC_API(void) XPT_DataOffset(XPTState *state, uint32 *data_offsetp); extern XPT_PUBLIC_API(void) XPT_SetDataOffset(XPTState *state, uint32 data_offset); extern XPT_PUBLIC_API(uint32) XPT_GetOffsetForAddr(XPTCursor *cursor, void *addr); extern XPT_PUBLIC_API(PRBool) XPT_SetOffsetForAddr(XPTCursor *cursor, void *addr, uint32 offset); extern XPT_PUBLIC_API(PRBool) XPT_SetAddrForOffset(XPTCursor *cursor, uint32 offset, void *addr); extern XPT_PUBLIC_API(void *) XPT_GetAddrForOffset(XPTCursor *cursor, uint32 offset); /* all data structures are big-endian */ #if defined IS_BIG_ENDIAN # define XPT_SWAB32(x) x # define XPT_SWAB16(x) x #elif defined IS_LITTLE_ENDIAN # define XPT_SWAB32(x) (((x) >> 24) | \ (((x) >> 8) & 0xff00) | \ (((x) << 8) & 0xff0000) | \ ((x) << 24)) # define XPT_SWAB16(x) (((x) >> 8) | ((x) << 8)) #else # error "unknown byte order" #endif /* * If we're decoding, we want to read the offset before we check * for already-decoded values. * * Then we check for repetition: CheckForRepeat will see if we've already * encoded/decoded this value, and if so will set offset/addr correctly * and make already be true. If not, it will set up the cursor for * encoding (reserve space) or decoding (seek to correct location) as * appropriate. In the encode case, it will also set the addr->offset * mapping. */ #define XPT_PREAMBLE_(cursor, addrp, pool, size, new_curs, already) \ XPTMode mode = cursor->state->mode; \ if (!(mode == XPT_ENCODE || XPT_Do32(cursor, &new_curs.offset)) || \ !CheckForRepeat(cursor, (void **)addrp, pool, \ mode == XPT_ENCODE ? size : 0, &new_curs, \ &already) || \ !(mode == XPT_DECODE || XPT_Do32(cursor, &new_curs.offset))) \ return PR_FALSE; \ if (already) \ return PR_TRUE; \ #define XPT_PREAMBLE(cursor, addrp, pool, size, new_curs, already, \ XPTType, localp) \ { \ XPT_PREAMBLE_(cursor, addrp, pool, size, new_curs, already); \ XPT_ALLOC(addrp, new_curs, XPTType, localp) \ } #define XPT_PREAMBLE_NO_ALLOC(cursor, addrp, pool, size, new_curs, already) \ { \ XPT_PREAMBLE_(cursor, addrp, pool, size, new_curs, already) \ } #define XPT_ERROR_HANDLE(free_it) \ error: \ if (cursor->state->mode == XPT_DECODE) \ PR_FREEIF(free_it); \ return PR_FALSE; PR_END_EXTERN_C #endif /* __xpt_xdr_h__ */