/* * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* File: CatalogPrivate.h Contains: Private Catalog Manager interfaces. Version: HFS Plus 1.0 Copyright: © 1997-1998 by Apple Computer, Inc., all rights reserved. File Ownership: DRI: Don Brady Other Contact: xxx put other contact here xxx Technology: xxx put technology here xxx Writers: (JL) Jim Luther (msd) Mark Day (DSH) Deric Horn (djb) Don Brady Change History (most recent first): <MacOSX> 11/10/98 djb Remove obsolete PrepareInputName prototype; <MacOSX> 4/6/98 djb Added lock data stuctures and ReleaseCatalogIterator prototype; <MacOSX> 4/6/98 djb Removed CatalogDataCache since its no longer used. <MacOSX> 4/2/98 djb InvalidateCatalogNodeCache does nothing under MacOS X. <MacOSX> 3/31/98 djb Sync up with final HFSVolumes.h header file. <CS10> 11/20/97 djb Radar #2002357. Fixing retry mechanism. <CS9> 11/17/97 djb PrepareInputName routine now returns an error. <CS8> 11/13/97 djb Radar #1683572. Move CatalogIterator to this file from FileMgrInternal.i. Double size of short unicode name. <CS7> 10/31/97 JL #2000184 - Changed prototypes for CreateFileThreadID and ExchangeFiles. <CS6> 10/17/97 msd In CatalogCacheGlobals, add room for a single UniStr255 so catalog iterators can step over long Unicode names. <CS5> 10/17/97 djb Add ConvertInputNameToUnicode for Catalog Create/Rename. <CS4> 10/1/97 djb Change catalog iterator implementation. <CS3> 7/16/97 DSH FilesInternal.i renamed FileMgrInternal.i to avoid name collision <CS2> 6/24/97 djb Add LocateCatalogNodeByMangledName routine. <CS1> 6/24/97 djb first checked in */ #ifndef __CATALOGPRIVATE__ #define __CATALOGPRIVATE__ #include <sys/appleapiopts.h> #ifdef KERNEL #ifdef __APPLE_API_PRIVATE #include "../../hfs_format.h" #include "FileMgrInternal.h" #include "BTreesInternal.h" // // Private Catalog Manager Routines (for use only by Catalog Manager, CatSearch and FileID Services) // extern OSErr LocateCatalogNode( const ExtendedVCB *volume, HFSCatalogNodeID folderID, const CatalogName *name, u_int32_t hint, CatalogKey *key, CatalogRecord *data, u_int32_t *newHint); extern OSErr LocateCatalogNodeByKey ( const ExtendedVCB *volume, u_int32_t hint, CatalogKey *keyPtr, CatalogRecord *dataPtr, u_int32_t *newHint ); extern OSErr LocateCatalogRecord( const ExtendedVCB *volume, HFSCatalogNodeID folderID, const CatalogName *name, u_int32_t hint, CatalogKey *keyPtr, CatalogRecord *dataPtr, u_int32_t *newHint); extern OSErr LocateCatalogNodeWithRetry ( const ExtendedVCB *volume, HFSCatalogNodeID folderID, ConstStr31Param pascalName, CatalogName *unicodeName, u_int32_t hint, CatalogKey *keyPtr, CatalogRecord *dataPtr, u_int32_t *newHint ); extern OSErr FlushCatalog( ExtendedVCB *volume); extern void ConvertInputNameToUnicode(ConstStr31Param name, TextEncoding encodingHint, TextEncoding *actualEncoding, CatalogName *catalogName); extern void BuildCatalogKey( HFSCatalogNodeID parentID, const CatalogName *name, Boolean isHFSPlus, CatalogKey *key); extern OSErr BuildCatalogKeyUTF8(ExtendedVCB *volume, HFSCatalogNodeID parentID, const unsigned char *name, u_int32_t length, CatalogKey *key, u_int32_t *textEncoding); extern void CopyCatalogName( const CatalogName *srcName, CatalogName *dstName, Boolean isHFSPLus); extern OSErr ResolveFileID( ExtendedVCB *vcb, HFSCatalogNodeID fileID, HFSCatalogNodeID *parentID, Str31 name ); #if 0 extern OSErr CreateFileThreadID( FIDParam *filePB, WDCBRecPtr *wdcbPtr ); extern OSErr ExchangeFiles( FIDParam *filePB, WDCBRecPtr *wdcbPtr ); #endif extern void UpdateCatalogName( ConstStr31Param srcName, Str31 destName ); #endif /* __APPLE_API_PRIVATE */ #endif /* KERNEL */ #endif //__CATALOGPRIVATE__