]> err.no Git - sope/blob - sope-gdl1/README-OSX.txt
corrected a wrong (intermediary) committed version, updated ChangeLog this time ;-)
[sope] / sope-gdl1 / README-OSX.txt
1 # $Id$
2
3 Building Notes
4 ==============
5
6 Prerequisites:
7 - Apple Developer Tools
8 - skyrix-xml
9 - skyrix-core
10
11 There are two ways to build SOPE on MacOSX, either using the gnustep-make
12 package or as native Xcode projects. The first option is usually used when
13 you build SOPE for use with OGo, while the latter is more appropriate for
14 SOPE:X applications.
15
16 Building using gstep-make:
17 ==========================
18
19 First install gnustep-make (eg v1.10), then ensure that GNUstep.sh is properly
20 sourced. For the build just enter:
21   make -s install
22 or
23   make -s debug=yes install
24 if you build with debug informations.
25
26 Building using Xcode:
27 =====================
28
29 The Xcode build comes in two variants, one for development and the other for
30 deployment.
31
32
33 Development
34 -----------
35 Development usually means you're happily hacking away at your pet
36 projects and sometimes want to update the SOPE frameworks. For this purpose
37 use the "all" target and the accompanied "Development" build style. Later,
38 you can narrow the target down to something more specific. For development we
39 assume the destination for frameworks to be /Library/Frameworks. Once you are
40 done building all the frameworks the loader commands of the frameworks will
41 have that destination path built in. In order to use the frameworks you either
42 have to install them (by copying them manually to their destination) or to
43 prepare symlinks from /Library/Frameworks to the place where the built products
44 are. I usually build everything in a central place (i.e. /Local/BuildArea) and
45 have symlinks from /Library/Frameworks to /Local/BuildArea for each of the
46 products.
47
48 Either copy them to the appropriate places or symlink them (my suggestion).
49
50
51 Deployment
52 ----------
53 Deployment in our terms means you want to copy all required SOPE products into
54 an application's app wrapper. For this step all frameworks need to be built in
55 a special fashion, as the "install_name" of the frameworks needs to be prepared
56 to point to a relative path in the app wrapper. The situation is even more
57 complicated as all frameworks during linking store the "install names" of other
58 frameworks in their mach loader commands. In order for this step not to break
59 we need to set up an environment which is clearly separated from the
60 Development environment. I chose to use $(USER_LIBRARY_DIR)/EmbeddedFrameworks
61 as the default destination for these builds. In order for your application to
62 easily pick up the built products and copy them into its app wrapper this
63 location needs to be fixed and easily accessible. Note that on my system
64 ~/Library/EmbeddedFrameworks is a symlink to /Library/EmbeddedFrameworks so
65 even if you don't like the location at all it's very easy to point it to 
66 somewhere else. As soon as you have set this up you can use the
67 "Wrapper Contents" target with the accompanied "Wrapper" build style to build
68 all wrapper contents in the appropriate fashion. When you're done you can copy
69 all the wrapper products into your application's wrapper. The expected
70 destination is the "Frameworks" directory in the wrappers "Contents" directory.
71 For a complete list of what you need to copy into your application's wrapper
72 see the "Direct Dependencies" of all "Wrapper Contents" targets in all SOPE
73 related projects. At the time of this writing the complete list for SOPE
74 consisted of the following:
75
76
77 Note: "A word on umbrellas"
78       The general idea of umbrellas is to make life easier by providing a cover
79       for linking. In an ideal world we would provide a SOPE umbrella (we 
80       actually do that) and you just link against that and forget about the
81       complete list. However, with the "Wrapper" style things do not work that
82       way. Because the "install name"s of all frameworks are relative paths,
83       during linking the mach dyld cannot find the dependend frameworks
84       (because the path isn't absolute) and thus symbol checking fails. This
85       directly leads to prebinding to fail which we really don't want since we
86       have such a huge dependency tree and prebinding escpecially in our case
87       speeds up loading significantly. So, umbrellas do not really help with
88       "Wrapper" products - in fact they just add to the overall dependency
89       graph without providing any benefit. With the notable exception of the
90       "Development" build style umbrellas are totally useless. If you're
91       not planning to do a "Wrapper" deployment you might be happy to have
92       the umbrellas, however, that's why they are still here.
93
94 Note: You cannot use the -buildAllTargets commandline argument for Xcode,
95       because the Xcode projects also contain a target to build in the
96       gstep-make environment (called GSM:all)
97
98
99 Prebinding Notes
100 ================
101
102 General technical information about prebinding is available from Apple at
103 http://developer.apple.com/documentation/Performance/Conceptual/LaunchTime/Tasks/Prebinding.html#//apple_ref/doc/uid/20001858.
104
105 OGo frameworks currently use the range from 0xC0000000 to 0xCFFFFFFF.
106
107 Any questions and feedback regarding our use of this range should go to
108 Marcus Müller <znek@mulle-kybernetik.com>.
109
110
111 sope-gdl1: 0xC6000000 - 0xC6FFFFFF
112 ==================================
113
114 0xC6000000 GDLAccess
115 0xC6FF0000 ???