IFCMDictionary.h

Go to the documentation of this file.

/*************************************************************************
* ADOBE CONFIDENTIAL
* ___________________
*
*  Copyright [2013] Adobe Systems Incorporated
*  All Rights Reserved.
*
* NOTICE:  All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any.  The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by all applicable intellectual 
* property laws, including trade secret and copyright laws.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
**************************************************************************/

#ifndef IFCM_DICTIONARY_H_
#define IFCM_DICTIONARY_H_

#include "FCMPreConfig.h"
#include "FCMTypes.h"
#include "IFCMUnknown.h"


/* -------------------------------------------------- Forward Decl */


/* -------------------------------------------------- Macros / Constants */

namespace FCM 
{
    FCM::ConstFCMIID FCMIID_IFCMDictionary =
        {0x8bb58643, 0x57e, 0x4158, {0x88, 0x76, 0x6f, 0xf3, 0x34, 0xe5, 0xec, 0xe6}};


    #define FCMDICT_RUNTIME_KEY_PREFIX    "_rt_"
}


/* -------------------------------------------------- Enums */

namespace FCM
{
    typedef enum
    {
        kFCMDictType_Invalid = 0,

        kFCMDictType_Dict = 1,

        kFCMDictType_PIFCMUnknown,

        kFCMDictType_Long,
        
        kFCMDictType_Float,
        
        kFCMDictType_Bool,
        
        kFCMDictType_FCMGUID,

        kFCMDictType_Bytes,
        
        kFCMDictType_StringRep8,

        kFCMDictType_Double,

        /* Last */
        _kFCMDictType_Last_

    } FCMDictRecTypeID;

};  // namespace FCM


/* -------------------------------------------------- Structs / Unions */


/* -------------------------------------------------- Class Decl */

namespace FCM
{ 
    BEGIN_DECLARE_INTERFACE(IFCMDictionary, FCMIID_IFCMDictionary)

        
         virtual FCM::Result _FCMCALL Add(
            CStringRep8 pKey,
            FCMDictRecTypeID type,
            FCM::PVoid value,
            FCM::U_Int32 valueLen) = 0;

    
         virtual FCM::Result _FCMCALL AddLevel(CStringRep8 pKey, PIFCMDictionary& ppDict) = 0;


         virtual FCM::Result _FCMCALL Remove(CStringRep8    pKey) = 0;


         virtual FCM::Result _FCMCALL Get(
             CStringRep8 pKey,
             FCMDictRecTypeID type,
             FCM::PVoid pValue,
             FCM::U_Int32& valueLen) = 0;


         virtual FCM::Result _FCMCALL Clear() = 0;


         virtual FCM::Result _FCMCALL Count(FCM::U_Int32& count) = 0;


         virtual FCM::Result _FCMCALL GetNth(
             FCM::U_Int32 index,
             StringRep8 & pKey,
             FCMDictRecTypeID& type,
             FCM::U_Int32& valueLen) = 0;


         virtual FCM::Result _FCMCALL GetInfo(
             CStringRep8 pKey,
             FCMDictRecTypeID& type,
             FCM::U_Int32& valueLen) = 0;

    END_DECLARE_INTERFACE

};  // namespace FCM


/* -------------------------------------------------- Inline / Functions */


#include "FCMPostConfig.h"

#endif //IFCM_DICTIONARY_H_