This document provides installation instructions for installing ODF for use with MPW based compilers.
Table of Contents
-------------------------
• Configuring your MPW Environment
• Installing ODF
• Installing Cyberdog Support
Configuring Your MPW Environment
Before installing ODF, you must make sure that your MPW environment is configured for compiling ODF. To do that, you must do the following:
1) Install MPW from ETO 20.
2) Install the MPW Additions.
3) Install the OpenDoc headers, libraries, and build support for MPW.
1) Install MPW from ETO 20.
Copy your MPW folder from the ETO 20 CD.
IMPORTANT: You must use the MrC and SCpp compilers found on ETO 20 (or later) to compile ODF, because ODF uses the template instantiation mechanisms of these compilers for its template-based classes.
2) Install the MPW Additions
The folder "MPW Additions" contains additions to your MPW environment that are necessary to build ODF. They include startup files, the QuickDrawGXLib shared library, which is missing from ETO #20 and is needed by ODF, as well as SOM for MPW. Copy the files in each subfolder to the corresponding folder in your MPW environment.
3) Install the OpenDoc headers, libraries, and build support for MPW.
In the "OpenDoc Development" folder, you will find two folders called "OpenDoc" and "Build Support". Copy them to your MPW Shell directory.
Installing ODF
For the most part, installing ODF is simply a matter of copying the ODF source and tools to your local hard drive. However, since ODF supports several different compilers, there are some files that you don't need to copy if you are doing all of your development with MPW.
The basic steps you need to follow when installing ODF for MPW are as shown in the following list. These steps are explained in more detail below.
1) Copy the ODFDev folder to your local hard drive.
2) Copy the stationery files for the ODF example parts to your Stationery folder. (optional)
3) Copy any desired reference materials to your local hard drive. (optional)
4) Make an alias to the ODF library (and sample parts).
5) Copy the UserStartup•ODF file to MPW's "Startup Items" folder.
Note: These steps describe how to install the Debug version of the ODFLibrary and examples. If you simply want to play with the Release version of the ODF parts, copy the appropriate files from the "ODF Sample Parts" folder to your system. For details on doing this, see the information about this folder in the Contents of This CD section of the Important Information document at the root level of ODF Release 1.
1) Copy the ODFDev folder to your local hard drive.
You can copy the ODFDev folder in its entirety to your local hard drive. This folder contains the ODF source code and the source code for ODF's example parts. The ODFDev:ODF subfolder also contains configurations and project setups for building the ODF libraries.
Once you’ve copied ODFDev, you can throw away folders for other environments. Inside the ODF folder, you can throw away the RB (Symantec C++ for PowerMacintosh - Rainbow) and CW (CodeWarrior) folders. You only need to keep the MC (MRC) and/or SC (Symantec) and SL (Shared Library) folders. The same is true for all the example projects.
The following table indicates for each folder which compiler is used and the resulting binary. Notice that the 68K ODF Shared Library is currently built with the Symantec 68K compiler and the PPC ODF Shared Library is built with CodeWarrior.
The following table indicates which folders are necessary for each supported compiler.
Folder CW/PPC CW/68K Symantec68K MrC Rainbow
CWPPCDebug Y N N N N
CWPPCRelease Y N N N N
MCPPCDebug N N N Y N
MCPPCRelease N N N Y N
RBPPCDebug N N N N Y
RBPPCRelease N N N N Y
CW68KDebug N Y N N N
CW68kRelease N Y N N N
SC68KDebug N N Y N N
SC68KRelease N N Y N N
SL68KDebug N Y Y N N
SL68KRelease N Y Y N N
SLPPCDebug Y N N Y Y
SLPPCRelease Y N N Y Y
2) Copy the stationery files for the ODF example parts to your Stationery folder. (optional)
If you want to run the ODF sample parts, you will need to copy the stationery files for these parts into your Stationery folder. The stationery files are located in the "ODF Sample Parts:Stationery" folder.
3) Copy any desired reference materials to your local hard drive. (optional)
ODF comes with several documents and tools, such as the ODF Class Reference and MacBrowse, that can make it easier to navigate through the ODF code. You can copy any of these to your local hard drive.
The "Documentation" folder contains the ODF Class Reference, which is a QuickView database that allows you to quickly search for the documentation for a particular class or method. Make sure that the QuickView application and the ODF Class Reference document are in the same folder when you launch the application.
The 'Tools & Goodies:MacBrowse' folder contains the MacBrowse application that enables you to browse the ODF source code directly. It also contains a subfolder with the MacParse tool, which you can use to create parsed files for use with MacBrowse.
The "Tools & Goodies:Object Master™" folder contains an empty ObjectMaster project, which you can use to create a browsable set of the ODF source code.
4) Make an alias to the ODF library (and sample parts).
To make debugging with ODF easier, you need to make an alias to the debug version of the ODF shared library and put the alias into your Editors folder. If your ODF environment is on a different volume than your system folder, you can create an Editors folder at the root level of your development hard drive and put the alias there. (OpenDoc does not allow you to put aliases to files on different volumes in the Editors folder.)
Note: The ODFLibrary (or an alias to it) must be located in your Editors folder. Part editors that were built with ODF require the existence of this library and will not run without it.
The debug versions of the ODF shared library (ODFLibrary) are already built. The ODFLibrary for PowerPC is located in the "ODFDev:ODF:SLPPCDebug:Bin:" folder. The ODFLibrary for 68K is located in the "ODFDef:ODF:SL68KDebug:Bin:" folder.
If you want to debug the ODF sample parts, you can also add an alias to each of these part editors to your Editors folder. The debug version of an ODF part editor is located within either the "MCPPCDebug:Bin:" folder for PowerPC or the "SC68KDebug:Bin:" folder for 68K of the particular sample part. For example, the debug, PowerPC part editor for ODFDraw is located in the "ODFDev:Draw:MCPPCDebug:Bin:" folder.
For convenience, you can also make an alias to the symbol files for the ODFLibrary (ODFLibrary.xSYM) and put it on your desktop. You can then use this alias to find the ODFLibrary debugging information quickly when you launch your debugger.
IMPORTANT: Make sure that the release version of the ODFLibrary or any of the ODF sample parts are not installed on your machine while you are attempting to trace through either the ODFLibrary or sample parts. The chances are good that you will not get the right library. OpenDoc searches for the first part editor and library that matches its search parameters. The release version of the ODF libraries and samples are simply optimized versions that do not have internal debugging information, such as Macsbug symbols or assertions.
5) Copy the UserStartup•ODF file to MPW's "Startup Items" folder.
The UserStartup•ODF file is located in the "ODFDev:MPW-ToolServer Additions" folder. Copy this file into your MPW's "Startup Items" folder and restart MPW. When MPW restarts, it will ask you to specify the location of your ODF folder. The folder you want to specify is "ODFDev:ODF:". MPW may also ask you to specify the location of your OpenDoc files. If the OpenDoc files are installed properly inside your MPW folder, you can simply specify your MPW folder, otherwise, you will have to specify your OpenDoc SDK folder containing the OpenDoc Interfaces and Libraries.
