Forbidden Characters

While mixing BSD and Core Services File Manager APIs work most of the time, it will fail if the file name contains a forbidden character, and each set of APIs has different rules:

• the BSD APIs allow the colon (":") character but forbid the slash ("/") character in a file name since this character is used as the directory delimiter,

• the Core Services File Manager APIs allow the slash character but forbid the colon character for legacy reasons since it was used as directory delimiter by previous versions of the Mac OS File Manager.

Thus trying to use file names obtained through BSD APIs in Core Services File Manager APIs, or vice versa, can fail at anytime if the file names contain the characters forbidden in the other set of APIs.

Terminal, Finder, and Forbidden Characters

To illustrate how both set of APIs react to forbidden characters, you can use Terminal to launch tools which are using BSD APIs and Finder which is using Core Services File Manager APIs.

Use the touch command to create the files "Library/test1" and "Library:test2" in your home directory as shown in Listing 1

Listing 1  touch in Terminal.

$ cd ~ $ touch Library/test1 $ touch Library:test2

Using the ls command, you will see a file named "Library:test2" in your home directory, and a file named "test1" in its Library subdirectory. The BSD APIs interpreted the slash character as a path separator but treated the colon character as a normal character.

Using the Finder to navigate to your home directory, you will see a file named "Library/test2", and a file named "test1" in its Library subdirectory. The colon is replaced by a slash in the first file name to prevent users from seeing and creating file names with colons.

The Solution

If the code which is mixing BSD APIs and Core Services File Manager APIs is not called in a large iteration but is, for instance, called in response to a user's action on one file, then the preferred solution is to simply use FSPathMakeRef and FSRefMakePath to convert between the set of APIs.

For performance reasons if the code is called very often, or if you are handling paths of non-existing-yet files (FSRefs cannot be used in that case), an alternate solution is to manually swap colons in slashes when going from BSD to Core Services File Manager and slashes to colons when going from Core Services File Manager to BSD. The names handled by the BSD APIs are UTF-8 C strings. The names handled by the Core Services File Manager APIs are Unicode UniChar arrays. Since you have to use UTF-8 C strings for or from BSD, the simplest solution is to swap the characters in that string.

Listing 2  Swapping colons and slashes in a UTF-8 C string.

static void SwapColonsAndSlashes(char * str)
{
    char * cursor = str;
    while (*cursor != 0)
    {
        if (*cursor == ':')
        {
            *cursor = '/';
        }
        else if (*cursor == '/')
        {
            *cursor = ':';
        }
        cursor += 1;
    }
}