This document provides installation instructions for installing ODF for use with MPW-based compilers.
Table of Contents
-------------------------
• Configuring your MPW Environment
• Installing ODF
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.
2) Install the MPW Additions.
3) Install the OpenDoc headers, libraries, and build support for MPW.
1) Install MPW.
Install the MPW environment using the Installer on disc 1 of the E.T.O. #21 CD-ROM set.
IMPORTANT: You must use the MrC and SCpp compilers found on E.T.O. #21 (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
First navigate into the “:OpenDoc Development Framework:Getting Started:MPW Development:” folder on the E.T.O. Frameworks CD-ROM. The folder here called "MPW Additions" contains additions to your MPW environment that are necessary to build ODF. They include startup files as well as files needed to use SOMobjects™ for Mac OS. To install:
• Open the MPW Additions folder and move the files UserStartup•OpenDoc and UserStartup•ODF into the Startup Items folder inside the MPW folder on your hard disk (i.e., the folder containing the MPW Shell). Move the file UserStartupTS•ODF into the TS Startup Items folder.
• Open the SOMobjects™ for Mac OS folder, then the MPW Additions folder. Move the UserStartup•somc file into the Startup Items folder inside the MPW folder on your hard disk. Move the contents of Scripts, Tools, and Examples folder into the corresponding folders inside the MPW folder on your hard disk. Move the contents of the subfolders of the Interfaces folder and the Libraries folder to the corresponding subfolders inside the Interfaces&Libraries folder on your hard disk (this latter folder is located at the same folder level as your MPW folder) -- if there is not a corresponding subfolder, create one first.
An easier way to install the SOMobjects MPW Additions is to execute the following lines from the worksheet of the MPW Shell:
Directory "E.T.O. Frameworks #21:OpenDoc Development Framework:Getting Started:"
Directory ":MPW Development:MPW Additions:SOMobjects™ for Mac OS:MPW Additions:"
Backup -r -a -c -from ":Examples:" -to "{MPW}Examples"
Backup -r -a -c -from ":Scripts:" -to "{MPW}Scripts"
Backup -r -a -c -from ":Tools:" -to "{MPW}Tools"
Backup -r -a -c -from ":Interfaces:" -to "{CIncludes}:"
Backup -r -a -c -from ":Libraries:" -to "{SharedLibraries}:"
These command generate a set of Duplicate commands which, when selected and executed, will move all the files into place.
3) Install the OpenDoc headers, libraries, and build support for MPW.
In the "OpenDoc Development" folder (inside the "OpenDoc Support for ODF" folder at the root level of the CD-ROM), you will find two folders called "OpenDoc" and "Build Support". Copy them to the MPW folder on your hard disk.
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 sample 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) Relaunch the MPW Shell.
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 inside the OpenDoc Development Framework folder.
1) Copy the ODFDev folder to your local hard drive.
Copy the ODFDev folder (in the OpenDoc Development Framework 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 Power Macintosh) and CW (CodeWarrior) folders. You only need to keep the MC (MrC/MrCpp for MPW) and/or SC (SC/SCpp for MPW) 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 MPW 68K C++ compiler (SCpp) 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 SCpp MrC Symantec C++
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 OpenDoc Stationery folder (located, by default, at the root level of your startup volume). The stationery files are located in the ":ODF Sample Parts:Stationery:" folder inside the OpenDoc Development Framework folder on the CD-ROM.
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 Assistant 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 browseable 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 (in the system folder of your startup volume). 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 ":ODFDev: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 neither the release version of the ODFLibrary nor any of the ODF sample parts is 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) Relaunch the MPW Shell.
If the MPW Shell application is running, quit it, then launch it again. It will ask you to specify the location of your ODF folder. The folder you want to specify is “:ODFDev:ODF:” on your hard disk. MPW may also ask you to specify the location of your OpenDoc (or OpenDoc SDK) files (and perhaps more than once -- sorry about that!). If the OpenDoc files are installed inside your MPW folder as described above, simply select the OpenDoc folder inside your MPW folder (this folder contains OpenDoc interfaces and libraries). Finally, you may be asked to locate the Build Support folder -- this folder is also located inside the MPW folder.
