Aliases.pas 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. {
  2. File: Aliases.p
  3. Contains: Alias Manager Interfaces.
  4. Version: Technology: Mac OS 8.1
  5. Release: Universal Interfaces 3.4.2
  6. Copyright: © 1989-2002 by Apple Computer, Inc., all rights reserved
  7. Bugs?: For bug reports, consult the following page on
  8. the World Wide Web:
  9. http://www.freepascal.org/bugs.html
  10. }
  11. {
  12. Modified for use with Free Pascal
  13. Version 200
  14. Please report any bugs to <[email protected]>
  15. }
  16. {$mode macpas}
  17. {$packenum 1}
  18. {$macro on}
  19. {$inline on}
  20. {$CALLING MWPASCAL}
  21. unit Aliases;
  22. interface
  23. {$setc UNIVERSAL_INTERFACES_VERSION := $0342}
  24. {$setc GAP_INTERFACES_VERSION := $0200}
  25. {$ifc not defined USE_CFSTR_CONSTANT_MACROS}
  26. {$setc USE_CFSTR_CONSTANT_MACROS := TRUE}
  27. {$endc}
  28. {$ifc defined CPUPOWERPC and defined CPUI386}
  29. {$error Conflicting initial definitions for CPUPOWERPC and CPUI386}
  30. {$endc}
  31. {$ifc defined FPC_BIG_ENDIAN and defined FPC_LITTLE_ENDIAN}
  32. {$error Conflicting initial definitions for FPC_BIG_ENDIAN and FPC_LITTLE_ENDIAN}
  33. {$endc}
  34. {$ifc not defined __ppc__ and defined CPUPOWERPC}
  35. {$setc __ppc__ := 1}
  36. {$elsec}
  37. {$setc __ppc__ := 0}
  38. {$endc}
  39. {$ifc not defined __i386__ and defined CPUI386}
  40. {$setc __i386__ := 1}
  41. {$elsec}
  42. {$setc __i386__ := 0}
  43. {$endc}
  44. {$ifc defined __ppc__ and __ppc__ and defined __i386__ and __i386__}
  45. {$error Conflicting definitions for __ppc__ and __i386__}
  46. {$endc}
  47. {$ifc defined __ppc__ and __ppc__}
  48. {$setc TARGET_CPU_PPC := TRUE}
  49. {$setc TARGET_CPU_X86 := FALSE}
  50. {$elifc defined __i386__ and __i386__}
  51. {$setc TARGET_CPU_PPC := FALSE}
  52. {$setc TARGET_CPU_X86 := TRUE}
  53. {$elsec}
  54. {$error Neither __ppc__ nor __i386__ is defined.}
  55. {$endc}
  56. {$setc TARGET_CPU_PPC_64 := FALSE}
  57. {$ifc defined FPC_BIG_ENDIAN}
  58. {$setc TARGET_RT_BIG_ENDIAN := TRUE}
  59. {$setc TARGET_RT_LITTLE_ENDIAN := FALSE}
  60. {$elifc defined FPC_LITTLE_ENDIAN}
  61. {$setc TARGET_RT_BIG_ENDIAN := FALSE}
  62. {$setc TARGET_RT_LITTLE_ENDIAN := TRUE}
  63. {$elsec}
  64. {$error Neither FPC_BIG_ENDIAN nor FPC_LITTLE_ENDIAN are defined.}
  65. {$endc}
  66. {$setc ACCESSOR_CALLS_ARE_FUNCTIONS := TRUE}
  67. {$setc CALL_NOT_IN_CARBON := FALSE}
  68. {$setc OLDROUTINENAMES := FALSE}
  69. {$setc OPAQUE_TOOLBOX_STRUCTS := TRUE}
  70. {$setc OPAQUE_UPP_TYPES := TRUE}
  71. {$setc OTCARBONAPPLICATION := TRUE}
  72. {$setc OTKERNEL := FALSE}
  73. {$setc PM_USE_SESSION_APIS := TRUE}
  74. {$setc TARGET_API_MAC_CARBON := TRUE}
  75. {$setc TARGET_API_MAC_OS8 := FALSE}
  76. {$setc TARGET_API_MAC_OSX := TRUE}
  77. {$setc TARGET_CARBON := TRUE}
  78. {$setc TARGET_CPU_68K := FALSE}
  79. {$setc TARGET_CPU_MIPS := FALSE}
  80. {$setc TARGET_CPU_SPARC := FALSE}
  81. {$setc TARGET_OS_MAC := TRUE}
  82. {$setc TARGET_OS_UNIX := FALSE}
  83. {$setc TARGET_OS_WIN32 := FALSE}
  84. {$setc TARGET_RT_MAC_68881 := FALSE}
  85. {$setc TARGET_RT_MAC_CFM := FALSE}
  86. {$setc TARGET_RT_MAC_MACHO := TRUE}
  87. {$setc TYPED_FUNCTION_POINTERS := TRUE}
  88. {$setc TYPE_BOOL := FALSE}
  89. {$setc TYPE_EXTENDED := FALSE}
  90. {$setc TYPE_LONGLONG := TRUE}
  91. uses MacTypes,Files;
  92. {$ALIGN MAC68K}
  93. const
  94. rAliasType = $616C6973 (* 'alis' *); { Aliases are stored as resources of this type }
  95. { define alias resolution action rules mask }
  96. kARMMountVol = $00000001; { mount the volume automatically }
  97. kARMNoUI = $00000002; { no user interface allowed during resolution }
  98. kARMMultVols = $00000008; { search on multiple volumes }
  99. kARMSearch = $00000100; { search quickly }
  100. kARMSearchMore = $00000200; { search further }
  101. kARMSearchRelFirst = $00000400; { search target on a relative path first }
  102. { define alias record information types }
  103. asiZoneName = -3; { get zone name }
  104. asiServerName = -2; { get server name }
  105. asiVolumeName = -1; { get volume name }
  106. asiAliasName = 0; { get aliased file/folder/volume name }
  107. asiParentName = 1; { get parent folder name }
  108. { ResolveAliasFileWithMountFlags options }
  109. kResolveAliasFileNoUI = $00000001; { no user interaction during resolution }
  110. { define the alias record that will be the blackbox for the caller }
  111. type
  112. AliasRecordPtr = ^AliasRecord;
  113. AliasRecord = record
  114. userType: OSType; { appl stored type like creator type }
  115. aliasSize: UInt16; { alias record size in bytes, for appl usage }
  116. end;
  117. AliasPtr = ^AliasRecord;
  118. AliasHandle = ^AliasPtr;
  119. { alias record information type }
  120. AliasInfoType = SInt16;
  121. {
  122. * NewAlias()
  123. *
  124. * Summary:
  125. * create a new alias between fromFile and target, returns alias
  126. * record handle
  127. *
  128. * Availability:
  129. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  130. * CarbonLib: in CarbonLib 1.0 and later
  131. * Mac OS X: in version 10.0 and later
  132. }
  133. function NewAlias(fromFile: {Const}FSSpecPtr; const (*var*) target: FSSpec; var alias: AliasHandle): OSErr; external name '_NewAlias';
  134. {
  135. * NewAliasMinimal()
  136. *
  137. * Summary:
  138. * create a minimal new alias for a target and return alias record
  139. * handle
  140. *
  141. * Availability:
  142. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  143. * CarbonLib: in CarbonLib 1.0 and later
  144. * Mac OS X: in version 10.0 and later
  145. }
  146. function NewAliasMinimal(const (*var*) target: FSSpec; var alias: AliasHandle): OSErr; external name '_NewAliasMinimal';
  147. {
  148. * NewAliasMinimalFromFullPath()
  149. *
  150. * Summary:
  151. * create a minimal new alias from a target fullpath (optional zone
  152. * and server name) and return alias record handle
  153. *
  154. * Availability:
  155. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  156. * CarbonLib: in CarbonLib 1.0 and later
  157. * Mac OS X: in version 10.0 and later
  158. }
  159. function NewAliasMinimalFromFullPath(fullPathLength: SInt16; fullPath: UnivPtr; const (*var*) zoneName: Str32; const (*var*) serverName: Str31; var alias: AliasHandle): OSErr; external name '_NewAliasMinimalFromFullPath';
  160. {
  161. * ResolveAlias()
  162. *
  163. * Summary:
  164. * given an alias handle and fromFile, resolve the alias, update the
  165. * alias record and return aliased filename and wasChanged flag.
  166. *
  167. * Availability:
  168. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  169. * CarbonLib: in CarbonLib 1.0 and later
  170. * Mac OS X: in version 10.0 and later
  171. }
  172. function ResolveAlias(fromFile: {Const}FSSpecPtr; alias: AliasHandle; var target: FSSpec; var wasChanged: boolean): OSErr; external name '_ResolveAlias';
  173. {
  174. * GetAliasInfo()
  175. *
  176. * Summary:
  177. * given an alias handle and an index specifying requested alias
  178. * information type, return the information from alias record as a
  179. * string.
  180. *
  181. * Availability:
  182. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  183. * CarbonLib: in CarbonLib 1.0 and later
  184. * Mac OS X: in version 10.0 and later
  185. }
  186. function GetAliasInfo(alias: AliasHandle; index: AliasInfoType; var theString: Str63): OSErr; external name '_GetAliasInfo';
  187. {
  188. * IsAliasFile()
  189. *
  190. * Availability:
  191. * Non-Carbon CFM: in InterfaceLib 8.5 and later
  192. * CarbonLib: in CarbonLib 1.0 and later
  193. * Mac OS X: in version 10.0 and later
  194. }
  195. function IsAliasFile(const (*var*) fileFSSpec: FSSpec; var aliasFileFlag: boolean; var folderFlag: boolean): OSErr; external name '_IsAliasFile';
  196. {
  197. * ResolveAliasWithMountFlags()
  198. *
  199. * Availability:
  200. * Non-Carbon CFM: in InterfaceLib 8.5 and later
  201. * CarbonLib: in CarbonLib 1.0 and later
  202. * Mac OS X: in version 10.0 and later
  203. }
  204. function ResolveAliasWithMountFlags(fromFile: {Const}FSSpecPtr; alias: AliasHandle; var target: FSSpec; var wasChanged: boolean; mountFlags: UInt32): OSErr; external name '_ResolveAliasWithMountFlags';
  205. {
  206. * ResolveAliasFile()
  207. *
  208. * Summary:
  209. * Given a file spec, return target file spec if input file spec is
  210. * an alias. It resolves the entire alias chain or one step of the
  211. * chain. It returns info about whether the target is a folder or
  212. * file; and whether the input file spec was an alias or not.
  213. *
  214. * Availability:
  215. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  216. * CarbonLib: in CarbonLib 1.0 and later
  217. * Mac OS X: in version 10.0 and later
  218. }
  219. function ResolveAliasFile(var theSpec: FSSpec; resolveAliasChains: boolean; var targetIsFolder: boolean; var wasAliased: boolean): OSErr; external name '_ResolveAliasFile';
  220. {
  221. * ResolveAliasFileWithMountFlags()
  222. *
  223. * Availability:
  224. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  225. * CarbonLib: in CarbonLib 1.0 and later
  226. * Mac OS X: in version 10.0 and later
  227. }
  228. function ResolveAliasFileWithMountFlags(var theSpec: FSSpec; resolveAliasChains: boolean; var targetIsFolder: boolean; var wasAliased: boolean; mountFlags: UInt32): OSErr; external name '_ResolveAliasFileWithMountFlags';
  229. {
  230. * FollowFinderAlias()
  231. *
  232. * Availability:
  233. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  234. * CarbonLib: in CarbonLib 1.0 and later
  235. * Mac OS X: in version 10.0 and later
  236. }
  237. function FollowFinderAlias(fromFile: {Const}FSSpecPtr; alias: AliasHandle; logon: boolean; var target: FSSpec; var wasChanged: boolean): OSErr; external name '_FollowFinderAlias';
  238. {
  239. Low Level Routines
  240. }
  241. {
  242. * UpdateAlias()
  243. *
  244. * Summary:
  245. * given a fromFile-target pair and an alias handle, update the
  246. * alias record pointed to by alias handle to represent target as
  247. * the new alias.
  248. *
  249. * Availability:
  250. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  251. * CarbonLib: in CarbonLib 1.0 and later
  252. * Mac OS X: in version 10.0 and later
  253. }
  254. function UpdateAlias(fromFile: {Const}FSSpecPtr; const (*var*) target: FSSpec; alias: AliasHandle; var wasChanged: boolean): OSErr; external name '_UpdateAlias';
  255. type
  256. {$ifc TYPED_FUNCTION_POINTERS}
  257. AliasFilterProcPtr = function(cpbPtr: CInfoPBPtr; var quitFlag: boolean; myDataPtr: Ptr): boolean;
  258. {$elsec}
  259. AliasFilterProcPtr = ProcPtr;
  260. {$endc}
  261. {$ifc OPAQUE_UPP_TYPES}
  262. AliasFilterUPP = ^SInt32; { an opaque UPP }
  263. {$elsec}
  264. AliasFilterUPP = UniversalProcPtr;
  265. {$endc}
  266. const
  267. uppAliasFilterProcInfo = $00000FD0;
  268. {
  269. * NewAliasFilterUPP()
  270. *
  271. * Availability:
  272. * Non-Carbon CFM: available as macro/inline
  273. * CarbonLib: in CarbonLib 1.0 and later
  274. * Mac OS X: in version 10.0 and later
  275. }
  276. function NewAliasFilterUPP(userRoutine: AliasFilterProcPtr): AliasFilterUPP; external name '_NewAliasFilterUPP'; { old name was NewAliasFilterProc }
  277. {
  278. * DisposeAliasFilterUPP()
  279. *
  280. * Availability:
  281. * Non-Carbon CFM: available as macro/inline
  282. * CarbonLib: in CarbonLib 1.0 and later
  283. * Mac OS X: in version 10.0 and later
  284. }
  285. procedure DisposeAliasFilterUPP(userUPP: AliasFilterUPP); external name '_DisposeAliasFilterUPP';
  286. {
  287. * InvokeAliasFilterUPP()
  288. *
  289. * Availability:
  290. * Non-Carbon CFM: available as macro/inline
  291. * CarbonLib: in CarbonLib 1.0 and later
  292. * Mac OS X: in version 10.0 and later
  293. }
  294. function InvokeAliasFilterUPP(cpbPtr: CInfoPBPtr; var quitFlag: boolean; myDataPtr: Ptr; userRoutine: AliasFilterUPP): boolean; external name '_InvokeAliasFilterUPP'; { old name was CallAliasFilterProc }
  295. {
  296. * MatchAlias()
  297. *
  298. * Summary:
  299. * Given an alias handle and fromFile, match the alias and return
  300. * aliased filename(s) and needsUpdate flag
  301. *
  302. * Availability:
  303. * Non-Carbon CFM: in InterfaceLib 7.1 and later
  304. * CarbonLib: in CarbonLib 1.0 and later
  305. * Mac OS X: in version 10.0 and later
  306. }
  307. function MatchAlias(fromFile: {Const}FSSpecPtr; rulesMask: UInt32; alias: AliasHandle; var aliasCount: SInt16; aliasList: FSSpecArrayPtr; var needsUpdate: boolean; aliasFilter: AliasFilterUPP; yourDataPtr: UnivPtr): OSErr; external name '_MatchAlias';
  308. {
  309. * ResolveAliasFileWithMountFlagsNoUI()
  310. *
  311. * Summary:
  312. * variation on ResolveAliasFile that does not prompt user with a
  313. * dialog
  314. *
  315. * Availability:
  316. * Non-Carbon CFM: not available
  317. * CarbonLib: in CarbonLib 1.0 and later
  318. * Mac OS X: in version 10.0 and later
  319. }
  320. function ResolveAliasFileWithMountFlagsNoUI(var theSpec: FSSpec; resolveAliasChains: boolean; var targetIsFolder: boolean; var wasAliased: boolean; mountFlags: UInt32): OSErr; external name '_ResolveAliasFileWithMountFlagsNoUI';
  321. {
  322. * MatchAliasNoUI()
  323. *
  324. * Summary:
  325. * variation on MatchAlias that does not prompt user with a dialog
  326. *
  327. * Availability:
  328. * Non-Carbon CFM: not available
  329. * CarbonLib: in CarbonLib 1.0 and later
  330. * Mac OS X: in version 10.0 and later
  331. }
  332. function MatchAliasNoUI(fromFile: {Const}FSSpecPtr; rulesMask: UInt32; alias: AliasHandle; var aliasCount: SInt16; aliasList: FSSpecArrayPtr; var needsUpdate: boolean; aliasFilter: AliasFilterUPP; yourDataPtr: UnivPtr): OSErr; external name '_MatchAliasNoUI';
  333. {
  334. * FSNewAlias()
  335. *
  336. * Availability:
  337. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  338. * CarbonLib: in CarbonLib 1.1 and later
  339. * Mac OS X: in version 10.0 and later
  340. }
  341. function FSNewAlias(fromFile: {Const}FSRefPtr; const (*var*) target: FSRef; var inAlias: AliasHandle): OSErr; external name '_FSNewAlias';
  342. {
  343. * FSNewAliasMinimal()
  344. *
  345. * Availability:
  346. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  347. * CarbonLib: in CarbonLib 1.1 and later
  348. * Mac OS X: in version 10.0 and later
  349. }
  350. function FSNewAliasMinimal(const (*var*) target: FSRef; var inAlias: AliasHandle): OSErr; external name '_FSNewAliasMinimal';
  351. {
  352. * FSIsAliasFile()
  353. *
  354. * Availability:
  355. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  356. * CarbonLib: in CarbonLib 1.1 and later
  357. * Mac OS X: in version 10.0 and later
  358. }
  359. function FSIsAliasFile(const (*var*) fileRef: FSRef; var aliasFileFlag: boolean; var folderFlag: boolean): OSErr; external name '_FSIsAliasFile';
  360. {
  361. * FSResolveAliasWithMountFlags()
  362. *
  363. * Availability:
  364. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  365. * CarbonLib: in CarbonLib 1.1 and later
  366. * Mac OS X: in version 10.0 and later
  367. }
  368. function FSResolveAliasWithMountFlags(fromFile: {Const}FSRefPtr; inAlias: AliasHandle; var target: FSRef; var wasChanged: boolean; mountFlags: UInt32): OSErr; external name '_FSResolveAliasWithMountFlags';
  369. {
  370. * FSResolveAlias()
  371. *
  372. * Availability:
  373. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  374. * CarbonLib: in CarbonLib 1.1 and later
  375. * Mac OS X: in version 10.0 and later
  376. }
  377. function FSResolveAlias(fromFile: {Const}FSRefPtr; alias: AliasHandle; var target: FSRef; var wasChanged: boolean): OSErr; external name '_FSResolveAlias';
  378. {
  379. * FSResolveAliasFileWithMountFlags()
  380. *
  381. * Availability:
  382. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  383. * CarbonLib: in CarbonLib 1.1 and later
  384. * Mac OS X: in version 10.0 and later
  385. }
  386. function FSResolveAliasFileWithMountFlags(var theRef: FSRef; resolveAliasChains: boolean; var targetIsFolder: boolean; var wasAliased: boolean; mountFlags: UInt32): OSErr; external name '_FSResolveAliasFileWithMountFlags';
  387. {
  388. * FSResolveAliasFile()
  389. *
  390. * Availability:
  391. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  392. * CarbonLib: in CarbonLib 1.1 and later
  393. * Mac OS X: in version 10.0 and later
  394. }
  395. function FSResolveAliasFile(var theRef: FSRef; resolveAliasChains: boolean; var targetIsFolder: boolean; var wasAliased: boolean): OSErr; external name '_FSResolveAliasFile';
  396. {
  397. * FSFollowFinderAlias()
  398. *
  399. * Availability:
  400. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  401. * CarbonLib: in CarbonLib 1.1 and later
  402. * Mac OS X: in version 10.0 and later
  403. }
  404. function FSFollowFinderAlias(fromFile: FSRefPtr; alias: AliasHandle; logon: boolean; var target: FSRef; var wasChanged: boolean): OSErr; external name '_FSFollowFinderAlias';
  405. {
  406. * FSUpdateAlias()
  407. *
  408. * Availability:
  409. * Non-Carbon CFM: in InterfaceLib 9.1 and later
  410. * CarbonLib: in CarbonLib 1.1 and later
  411. * Mac OS X: in version 10.0 and later
  412. }
  413. function FSUpdateAlias(fromFile: {Const}FSRefPtr; const (*var*) target: FSRef; alias: AliasHandle; var wasChanged: boolean): OSErr; external name '_FSUpdateAlias';
  414. {$ALIGN MAC68K}
  415. end.