API: SPBasic.h Source File

00001 /***********************************************************************/
00002 /*                                                                     */
00003 /* SPBasic.h                                                           */
00004 /*                                                                     */
00005 /* ADOBE SYSTEMS INCORPORATED                                          */
00006 /* Copyright 1995-2007 Adobe Systems Incorporated.                     */
00007 /* All Rights Reserved.                                                */
00008 /*                                                                     */
00009 /* NOTICE:  Adobe permits you to use, modify, and distribute this file */
00010 /* in accordance with the terms of the Adobe license agreement         */
00011 /* accompanying it. If you have received this file from a source other */
00012 /* than Adobe, then your use, modification, or distribution of it      */
00013 /* requires the prior written permission of Adobe.                     */
00014 /*                                                                     */
00015 /* Patents Pending                                                     */
00016 /*                                                                     */
00017 /*                                                                     */
00018 /***********************************************************************/
00019 
00020 #ifndef __SPBasic__
00021 #define __SPBasic__
00022 
00023 
00024 /*******************************************************************************
00025  **
00026  **     Imports
00027  **
00028  **/
00029 
00030 #include "SPTypes.h"
00031 #include "AIBasicTypes.h"
00032 
00033 #include "SPHeaderBegin.h"
00034 
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00039 
00040 /*******************************************************************************
00041  **
00042  **     Constants
00043  **
00044  **/
00046 #define kSPBasicSuite                           "SP Basic Suite"
00047 
00048 #define kSPBasicSuiteVersion            4
00049 
00050 
00051 /*******************************************************************************
00052  **
00053  **     Suite
00054  **
00055  **/
00056 
00084 typedef struct SPBasicSuite {
00098         SPAPI SPErr (*AcquireSuite)( const char *name, ai::int32 version, const void **suite );
00104         SPAPI SPErr (*ReleaseSuite)( const char *name, ai::int32 version );
00110         SPAPI SPBoolean (*IsEqual)( const char *token1, const char *token2 );
00116         SPAPI SPErr (*AllocateBlock)( size_t size, void **block );
00121         SPAPI SPErr (*FreeBlock)( void *block );
00129         SPAPI SPErr (*ReallocateBlock)( void *block, size_t newSize, void **newblock );
00154         SPAPI SPErr (*Undefined)( void );
00155 
00156 } SPBasicSuite;
00157 
00158 
00160 SPAPI SPErr SPBasicAcquireSuite( const char *name, ai::int32 version, const void **suite );
00162 SPAPI SPErr SPBasicReleaseSuite( const char *name, ai::int32 version );
00164 SPAPI SPBoolean SPBasicIsEqual( const char *token1, const char *token2 );
00166 SPAPI SPErr SPBasicAllocateBlock( size_t size, void **block );
00168 SPAPI SPErr SPBasicFreeBlock( void *block );
00170 SPAPI SPErr SPBasicReallocateBlock( void *block, size_t newSize, void **newblock );
00172 SPAPI SPErr SPBasicUndefined( void );
00174 SPAPI SPErr SPSubAllocateBlock( size_t size, void **block );
00176 SPAPI SPErr SPSubFreeBlock( void *block );
00178 SPAPI SPErr SPSubReallocateBlock( void *block, size_t newSize, void **newblock );
00179 
00180 
00181 /*******************************************************************************
00182  **
00183  **     Errors
00184  **
00185  **/
00186 
00187 #include "SPErrorCodes.h"
00188 
00189 #ifdef __cplusplus
00190 }
00191 #endif
00192 
00193 #include "SPHeaderEnd.h"
00194 
00195 #endif