NameRegistry.h

Go to the documentation of this file.

 
#ifndef __NAMEREGISTRY__
#define __NAMEREGISTRY__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = power
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
    /********************************************************************************
     *
     * Foundation Types
     *
     */
    typedef void *RegPropertyValue;
    typedef UInt32 RegPropertyValueSize;
    /********************************************************************************
     *
     * RegEntryID   :   The Global x-Namespace Entry Identifier
     *
     */
    struct RegEntryID
    {
        UInt32 contents[4];
    };
    typedef struct RegEntryID RegEntryID;
    typedef RegEntryID *RegEntryIDPtr;
    /********************************************************************************
     *
     * Root Entry Name Definitions  (Applies to all Names in the RootNameSpace)
     *
     *  © Names are a colon-separated list of name components.  Name components
     *    may not themselves contain colons.
     *  © Names are presented as null-terminated ASCII character strings.
     *  © Names follow similar parsing rules to Apple file system absolute
     *    and relative paths.  However the '::' parent directory syntax is
     *    not currently supported.
     */
    enum
    {
        kRegCStrMaxEntryNameLength = 47
    };
 
    typedef char RegCStrEntryName;
    typedef char *RegCStrEntryNamePtr;
    typedef char RegCStrEntryNameBuf[48];
    typedef char RegCStrPathName;
    typedef UInt32 RegPathNameSize;
    enum
    {
        kRegPathNameSeparator = ':',    
        kRegEntryNameTerminator = 0x00, 
        kRegPathNameTerminator = 0x00   
    };
 
    /********************************************************************************
     *
     * Property Name and ID Definitions
     *  (Applies to all Properties Regardless of NameSpace)
     */
    enum
    {
        kRegMaximumPropertyNameLength = 31, 
        kRegPropertyNameTerminator = 0x00   
    };
 
    typedef char RegPropertyNameBuf[32];
    typedef char RegPropertyName;
    typedef char *RegPropertyNamePtr;
    /********************************************************************************
     *
     * Iteration Operations
     *
     *  These specify direction when traversing the name relationships
     */
    typedef UInt32 RegIterationOp;
    typedef RegIterationOp RegEntryIterationOp;
    enum
    {
        kRegIterRoot = 0x00000002,        
        kRegIterParents = 0x00000003,     
        kRegIterChildren = 0x00000004,    
        kRegIterSubTrees = 0x00000005,    
        kRegIterDescendants = 0x00000005, 
        kRegIterSibling = 0x00000006,     
        kRegIterContinue = 0x00000001
    };
 
    /********************************************************************************
     *
     * Name Entry and Property Modifiers
     *
     *
     *
     * Modifiers describe special characteristics of names
     * and properties.  Modifiers might be supported for
     * some names and not others.
     *
     * Device Drivers should not rely on functionality
     * specified as a modifier.
     */
    typedef UInt32 RegModifiers;
    typedef RegModifiers RegEntryModifiers;
    typedef RegModifiers RegPropertyModifiers;
    enum
    {
        kRegNoModifiers = 0x00000000,           
        kRegUniversalModifierMask = 0x0000FFFF, 
        kRegNameSpaceModifierMask =
            0x00FF0000,                     
        kRegModifierMask = (long)0xFF000000 
    };
 
    enum
    {
        kRegPropertyValueIsSavedToNVRAM =
            0x00000020, 
        kRegPropertyValueIsSavedToDisk =
            0x00000040 
    };
 
    enum
    {
        LatestNR_PEFVersion =
            0x01030000 
    };
 
 
    enum
    {
        kSelectRegistryEntryIDInit = 0,
        kSelectRegistryEntryIDCompare = 1,
        kSelectRegistryEntryIDCopy = 2,
        kSelectRegistryEntryIDDispose = 3,
        kSelectRegistryCStrEntryCreate = 4,
        kSelectRegistryEntryDelete = 5,
        kSelectRegistryEntryCopy = 6,
        kSelectRegistryEntryIterateCreate = 7,
        kSelectRegistryEntryIterateDispose = 8,
        kSelectRegistryEntryIterateSet = 9,
        kSelectRegistryEntryIterate = 10,
        kSelectRegistryEntrySearch = 11,
        kSelectRegistryCStrEntryLookup = 12,
        kSelectRegistryEntryToPathSize = 13,
        kSelectRegistryCStrEntryToPath = 14,
        kSelectRegistryCStrEntryToName = 15,
        kSelectRegistryPropertyCreate = 16,
        kSelectRegistryPropertyDelete = 17,
        kSelectRegistryPropertyRename = 18,
        kSelectRegistryPropertyIterateCreate = 19,
        kSelectRegistryPropertyIterateDispose = 20,
        kSelectRegistryPropertyIterate = 21,
        kSelectRegistryPropertyGetSize = 22,
        kSelectRegistryPropertyGet = 23,
        kSelectRegistryPropertySet = 24,
        kSelectRegistryEntryGetMod = 25,
        kSelectRegistryEntrySetMod = 26,
        kSelectRegistryPropertyGetMod = 27,
        kSelectRegistryPropertySetMod = 28,
        kSelectRegistryEntryMod = 29,
        kSelectRegistryEntryPropertyMod =
            30, 
        kSelectRegistryHighestSelector = kSelectRegistryEntryPropertyMod
    };
 
 
#if CALL_NOT_IN_CARBON
    OSStatus
    RegistryEntryIDInit(RegEntryID *id);
 
    Boolean
    RegistryEntryIDCompare(const RegEntryID *id1, const RegEntryID *id2);
 
    OSStatus
    RegistryEntryIDCopy(const RegEntryID *src, RegEntryID *dst);
 
    OSStatus
    RegistryEntryIDDispose(RegEntryID *id);
 
    OSStatus
    RegistryCStrEntryCreate(const RegEntryID *parentEntry,
                            const RegCStrPathName *name, RegEntryID *newEntry);
 
    OSStatus
    RegistryEntryDelete(const RegEntryID *id);
 
    OSStatus
    RegistryEntryCopy(RegEntryID *parentEntryID, RegEntryID *sourceDevice,
                      RegEntryID *destDevice);
 
#endif 
    typedef struct OpaqueRegEntryIter *RegEntryIter;
#if CALL_NOT_IN_CARBON
    OSStatus
    RegistryEntryIterateCreate(RegEntryIter *cookie);
 
    OSStatus
    RegistryEntryIterateDispose(RegEntryIter *cookie);
 
    OSStatus
    RegistryEntryIterateSet(RegEntryIter *cookie, const RegEntryID *startEntryID);
 
    OSStatus
    RegistryEntryIterate(RegEntryIter *cookie, RegEntryIterationOp relationship,
                         RegEntryID *foundEntry, Boolean *done);
 
    OSStatus
    RegistryEntrySearch(RegEntryIter *cookie, RegEntryIterationOp relationship,
                        RegEntryID *foundEntry, Boolean *done,
                        const RegPropertyName *propertyName,
                        const void *propertyValue,
                        RegPropertyValueSize propertySize);
 
    OSStatus
    RegistryCStrEntryLookup(const RegEntryID *searchPointID,
                            const RegCStrPathName *pathName, RegEntryID *foundEntry);
 
    OSStatus
    RegistryEntryToPathSize(const RegEntryID *entryID, RegPathNameSize *pathSize);
 
    OSStatus
    RegistryCStrEntryToPath(const RegEntryID *entryID, RegCStrPathName *pathName,
                            RegPathNameSize pathSize);
 
    OSStatus
    RegistryCStrEntryToName(const RegEntryID *entryID, RegEntryID *parentEntry,
                            RegCStrEntryName *nameComponent, Boolean *done);
 
 
    OSStatus
    RegistryPropertyCreate(const RegEntryID *entryID,
                           const RegPropertyName *propertyName,
                           const void *propertyValue,
                           RegPropertyValueSize propertySize);
 
    OSStatus
    RegistryPropertyDelete(const RegEntryID *entryID,
                           const RegPropertyName *propertyName);
 
    OSStatus
    RegistryPropertyRename(const RegEntryID *entry, const RegPropertyName *oldName,
                           const RegPropertyName *newName);
 
#endif 
    typedef struct OpaqueRegPropertyIter *RegPropertyIter;
#if CALL_NOT_IN_CARBON
    OSStatus
    RegistryPropertyIterateCreate(const RegEntryID *entry, RegPropertyIter *cookie);
 
    OSStatus
    RegistryPropertyIterateDispose(RegPropertyIter *cookie);
 
    OSStatus
    RegistryPropertyIterate(RegPropertyIter *cookie, RegPropertyName *foundProperty,
                            Boolean *done);
 
    OSStatus
    RegistryPropertyGetSize(const RegEntryID *entryID,
                            const RegPropertyName *propertyName,
                            RegPropertyValueSize *propertySize);
 
    OSStatus
    RegistryPropertyGet(const RegEntryID *entryID,
                        const RegPropertyName *propertyName, void *propertyValue,
                        RegPropertyValueSize *propertySize);
 
    OSStatus
    RegistryPropertySet(const RegEntryID *entryID,
                        const RegPropertyName *propertyName,
                        const void *propertyValue,
                        RegPropertyValueSize propertySize);
 
 
    OSStatus
    RegistryEntryGetMod(const RegEntryID *entry, RegEntryModifiers *modifiers);
 
    OSStatus
    RegistryEntrySetMod(const RegEntryID *entry, RegEntryModifiers modifiers);
 
    OSStatus
    RegistryPropertyGetMod(const RegEntryID *entry, const RegPropertyName *name,
                           RegPropertyModifiers *modifiers);
 
    OSStatus
    RegistryPropertySetMod(const RegEntryID *entry, const RegPropertyName *name,
                           RegPropertyModifiers modifiers);
 
    OSStatus
    RegistryEntryMod(RegEntryIter *cookie, RegEntryIterationOp relationship,
                     RegEntryID *foundEntry, Boolean *done,
                     RegEntryModifiers matchingModifiers);
 
    OSStatus
    RegistryEntryPropertyMod(RegEntryIter *cookie, RegEntryIterationOp relationship,
                             RegEntryID *foundEntry, Boolean *done,
                             RegPropertyModifiers matchingModifiers);
 
#endif 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif