API: AINameSpace.h Source File

00001 #ifndef __AINameSpace__
00002 #define __AINameSpace__
00003 
00004 /*
00005  *        Name: AINameSpace.h
00006  *   $Revision: 4 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Name Space Suite.
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 1986-2007 Adobe Systems Incorporated.
00013  * All rights reserved.
00014  *
00015  * NOTICE:  Adobe permits you to use, modify, and distribute this file 
00016  * in accordance with the terms of the Adobe license agreement 
00017  * accompanying it. If you have received this file from a source other 
00018  * than Adobe, then your use, modification, or distribution of it 
00019  * requires the prior written permission of Adobe.
00020  *
00021  */
00022 
00023 
00024 /*******************************************************************************
00025  **
00026  **     Imports
00027  **
00028  **/
00029 
00030 #ifndef __AITypes__
00031 #include "AITypes.h"
00032 #endif
00033 
00034 #ifndef __AIDataFilter__
00035 #include "AIDataFilter.h"
00036 #endif
00037 
00038 #ifndef __AIStringPool__
00039 #include "AIStringPool.h"
00040 #endif
00041 
00042 
00043 #include "AIHeaderBegin.h"
00044 
00047 /*******************************************************************************
00048  **
00049  ** Constants
00050  **
00051  **/
00052 
00053 #define kAINameSpaceSuite               "AI Name Space Suite"
00054 #define kAINameSpaceSuiteVersion                AIAPI_VERSION(4)
00055 #define kAINameSpaceVersion             kAINameSpaceSuiteVersion
00056 
00059 #define kNameSpaceErr                   'NAME'
00060 
00061 
00062 /*******************************************************************************
00063  **
00064  **     Types
00065  **
00066  **/
00067 
00069 typedef struct NameSpace AINameSpace;
00070 
00071 #if __BUILD_PLUGIN__
00072 #define kNSMaxNameLength                (1024)
00073 #define kNSMaxPathLength                ((kNSMaxNameLength + 1) * 5)
00074 #define kNSPathSeparator                '/'
00075 typedef char NSPath[kNSMaxPathLength + 1];
00076 typedef char NSName[kNSMaxNameLength + 1];
00077 #endif
00078 
00079 
00080 /*******************************************************************************
00081  **
00082  **     Suite
00083  **
00084  **/
00085 
00112 typedef struct {
00113 
00121         AIErr (*AllocateNameSpace) ( AIStringPool *pool, AINameSpace **space );
00122 
00127         AIErr (*DisposeNameSpace) ( AINameSpace *space );
00128 
00141         AIErr (*SetValue) ( const AINameSpace *space, const char *path, const char *type, ... );
00142 
00155         AIErr (*GetValue) ( const AINameSpace *space, const char *path, const char *type, ... );
00156 
00167         AIErr (*GetType) ( const AINameSpace *space, const char *path, char **type );
00168 
00176         AIErr (*GetChangeCount) ( const AINameSpace *space, const char *path, ai::int32 *count );
00177 
00182         AIErr (*RemoveValue) ( const AINameSpace *space, const char *path );
00183 
00191         AIErr (*CountPaths) ( const AINameSpace *space, const char *path, ai::int32 *count );
00192 
00201         AIErr (*GetNthPath) ( const AINameSpace *space, const char *path, ai::int32 n, char *nthPath );
00202 
00210         AIErr (*ParseValue) ( const AINameSpace *space, const char *path, AIDataFilter *filter );
00211 
00221         AIErr (*FlushValue) ( const AINameSpace *space, const char *path, AIDataFilter *filter );
00222 
00223 } AINameSpaceSuite;
00224 
00225 
00226 #include "AIHeaderEnd.h"
00227 
00228 #endif