summaryrefslogtreecommitdiffstats
path: root/mkspecs/features/symbian/platform_paths.prf
blob: a55e84207b35eebfef405a514a16f317f607fe66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
#
# ==============================================================================
#  Name        : platform_paths.prf
#  Part of     : 
#  Interface   : Platform Path Definitions API for Qt/S60
#  Description : Predefined include paths to be used in the pro-files for the 
#                components in the layered model. There is one definition for
#                each layer. The pro-file should use the statement that is 
#                intended for the same layer as where the pro-file resides.
#
# Usage examples:
#
#     Note: this file gets automatically added to all Qt/S60 projects
#    
#     Variable usages to add the system include paths
#       
#       The include paths has to be related to the layer in which your SW 
#       resides. Thus as an example: a component residing in middleware
#       layer should use the MW specific macro.
#
#         INCLUDEPATH += $$APP_LAYER_SYSTEMINCLUDE
#         INCLUDEPATH += $$MW_LAYER_SYSTEMINCLUDE
#         INCLUDEPATH += $$OS_LAYER_SYSTEMINCLUDE
#
#       If there is a need to include public headers of some S60 component,
#       various *_EXPORT_PATH macros can be utilized:
#
#         INCLUDEPATH += $$OS_LAYER_PUBLIC_EXPORT_PATH(somecomponent)
#
#     Variables related to using various parts of stdapis:
#
#       To use STLLIB you need to have this in your pro-file:
#
#         QMAKE_CXXFLAGS.CW *= $$STLLIB_USAGE_CW_FLAGS
#         DEFINES *= $$STLLIB_USAGE_DEFINES
#
#       Depending on what module you are using from stdapis you need to have
#       one or more of the following variables in your pro-file.
#
#         INCLUDEPATH += $$OS_LAYER_LIBC_SYSTEMINCLUDE
#         INCLUDEPATH += $$OS_LAYER_GLIB_SYSTEMINCLUDE
#         INCLUDEPATH += $$OS_LAYER_SSL_SYSTEMINCLUDE
#         INCLUDEPATH += $$OS_LAYER_STDCPP_SYSTEMINCLUDE
#         INCLUDEPATH += $$OS_LAYER_BOOST_SYSTEMINCLUDE
#         INCLUDEPATH += $$OS_LAYER_DBUS_SYSTEMINCLUDE
#         INCLUDEPATH += $$OS_LAYER_LIBUTILITY_SYSTEMINCLUDE
#
#
#       
#
# ==============================================================================

exists($${EPOCROOT}epoc32/include/platform_paths.prf) {
    
    # Load platform specific paths
    load($${EPOCROOT}epoc32/include/platform_paths.prf)

} else {  

    # No platform specific paths provided, use default paths

    exists($${EPOCROOT}epoc32/include/mw) { # New SF structure
    
        # ---------------------------------------
        # Location, where the applications layer specific public headers are exported
        # ---------------------------------------

        defineReplace(APP_LAYER_SDK_EXPORT_PATH) {
             return (/epoc32/include/app/$$1)
        }
        defineReplace(APP_LAYER_PUBLIC_EXPORT_PATH) {
             return (/epoc32/include/app/$$1)
        }

        # ---------------------------------------
        # Location, where the applications layer specific platform headers are exported
        # ---------------------------------------

        defineReplace(APP_LAYER_DOMAIN_EXPORT_PATH) {
             return (/epoc32/include/platform/app/$$1)
        }
        defineReplace(APP_LAYER_PLATFORM_EXPORT_PATH) {
             return (/epoc32/include/platform/app/$$1)
        }

        # ---------------------------------------
        # Location, where the middleware layer specific public headers are exported
        # ---------------------------------------

        defineReplace(MW_LAYER_SDK_EXPORT_PATH) {
             return (/epoc32/include/mw/$$1)
        }
        defineReplace(MW_LAYER_PUBLIC_EXPORT_PATH) {
             return (/epoc32/include/mw/$$1)
        }

        # ---------------------------------------
        # Location, where the middleware layer specific platform headers are exported
        # ---------------------------------------

        defineReplace(MW_LAYER_DOMAIN_EXPORT_PATH) {
             return (/epoc32/include/platform/mw/$$1)
        }
        defineReplace(MW_LAYER_PLATFORM_EXPORT_PATH) {
             return (/epoc32/include/platform/mw/$$1)
        }

        # ---------------------------------------
        # Location, where the os layer specific public headers are exported
        # ---------------------------------------

        defineReplace(OSEXT_LAYER_SDK_EXPORT_PATH) {
             return (/epoc32/include/$$1)
        }
        # WARNING: If the following path changes see the exists() function around line 219
        defineReplace(OS_LAYER_PUBLIC_EXPORT_PATH) {
             return (/epoc32/include/$$1)
        }

        # ---------------------------------------
        # Location, where the os specific platform headers are exported
        # ---------------------------------------

        defineReplace(OSEXT_LAYER_DOMAIN_EXPORT_PATH) {
             return (/epoc32/include/platform/$$1)
        }
        defineReplace(OS_LAYER_PLATFORM_EXPORT_PATH) {
             return (/epoc32/include/platform/$$1)
        }

        # ---------------------------------------
        #  General comments about the 3 define statements related to include paths:
        #  1) the /epoc32/include/oem is now defined there for backward compability.
        #     Once the directory is empty, the directory will be removed. However this 
        #     enables us to ensure that if you use these define statements => you do 
        #     not have to remove the statements later on, when the directory no longer 
        #     exists.
        #  2) These statements should be enough in normal cases. For certain specific 
        #     cases you might need to add some specific directory from /epoc32/include
        #     (for instance /epoc32/include/ecom).
        #     In normal cases the include staments in code should be relative to one of 
        #     the system include paths, but in certain cases, the included files requires
        #     that the subdirectory is also part of the system include paths.
        # ---------------------------------------

        # This variable defines the include paths, which are intended to be 
        # used in the pro-files that are part of the applications-layer. It includes all 
        # the needed directories from the /epoc32/include, that are valid ones for the 
        # application-layer components. 
        #
        # Applications layer is the last one in the list, since most likely the most of 
        # the headers come from middleware or os-layer  => thus they are first.

        APP_LAYER_SYSTEMINCLUDE = \
         /epoc32/include \
         /epoc32/include/mw \
         /epoc32/include/platform/mw \
         /epoc32/include/platform \
         /epoc32/include/app \
         /epoc32/include/platform/app \
         /epoc32/include/platform/loc \
         /epoc32/include/platform/mw/loc \
         /epoc32/include/platform/app/loc \
         /epoc32/include/platform/loc/sc \
         /epoc32/include/platform/mw/loc/sc \
         /epoc32/include/platform/app/loc/sc

        # This define statements defines the include paths, which are intended to be
        # used in the pro-files that are part of the middleware-layer. It includes all 
        # the needed directories from the /epoc32/include, that are valid ones for the 
        # middleware-layer components. 

        MW_LAYER_SYSTEMINCLUDE = \
         /epoc32/include \
         /epoc32/include/mw \
         /epoc32/include/platform/mw \
         /epoc32/include/platform \
         /epoc32/include/platform/loc \
         /epoc32/include/platform/mw/loc \
         /epoc32/include/platform/loc/sc \
         /epoc32/include/platform/mw/loc/sc

        # This define statements defines the include paths, which are intended to be
        # used in the pro-files that are part of the  osextensions-layer. It includes all
        # the needed directories from the /epoc32/include, that are valid ones for the
        # os-layer components. 

        OS_LAYER_SYSTEMINCLUDE = \
         /epoc32/include \
         /epoc32/include/platform \
         /epoc32/include/platform/loc \
         /epoc32/include/platform/loc/sc

        # This define statements defines the include paths, which are intended to be
        # used in the pro-files that are part of the os-layer. This is intended 
        # to be only used by those components which need to use in their mmp-file either
        # kern_ext.mmh or nkern_ext.mmh. Reason is that those
        # 2 files already contain the /epoc32/include  as system include path.

        OS_LAYER_KERNEL_SYSTEMINCLUDE = \
         /epoc32/include/platform


        # ---------------------------------------
        # Definitions that also define the systeminclude paths for various
        # part of stdapis. Append to INCLUDEPATH in pro-file.
        # ---------------------------------------

        OS_LAYER_LIBC_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/sys)

        OS_LAYER_GLIB_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/glib-2.0) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/glib-2.0/glib) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/glib-2.0/gObject)

        OS_LAYER_SSL_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/openssl)

        # stlportv5 is preferred over stlport as it has the throwing version of operator new
        exists($${EPOCROOT}epoc32/include/stdapis/stlport) \
        :!exists($${EPOCROOT}epoc32/include/stdapis/stlportv5) {
            OS_LAYER_STDCPP_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/stlport)
        } else {
            OS_LAYER_STDCPP_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/stlportv5)
        }
        
        OS_LAYER_BOOST_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/boost)

        OS_LAYER_DBUS_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/dbus-1.0) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/dbus-1.0/dbus)

        OS_LAYER_LIBUTILITY_SYSTEMINCLUDE = $$OS_LAYER_PLATFORM_EXPORT_PATH(stdapis/utility)

    } else { # Old pre-SF structure

        # ---------------------------------------
        # Location, where the applications layer specific public headers are exported
        # ---------------------------------------

        defineReplace(APP_LAYER_SDK_EXPORT_PATH) {
             return (/epoc32/include/applications/$$1)
        }
        defineReplace(APP_LAYER_PUBLIC_EXPORT_PATH) {
             return (/epoc32/include/applications/$$1)
        }

        # ---------------------------------------
        # Location, where the applications layer specific platform headers are exported
        # ---------------------------------------

        defineReplace(APP_LAYER_DOMAIN_EXPORT_PATH) {
             return (/epoc32/include/domain/applications/$$1)
        }
        defineReplace(APP_LAYER_PLATFORM_EXPORT_PATH) {
             return (/epoc32/include/domain/applications/$$1)
        }

        # ---------------------------------------
        # Location, where the middleware layer specific public headers are exported
        # ---------------------------------------

        defineReplace(MW_LAYER_SDK_EXPORT_PATH) {
             return (/epoc32/include/middleware/$$1)
        }
        defineReplace(MW_LAYER_PUBLIC_EXPORT_PATH) {
             return (/epoc32/include/middleware/$$1)
        }

        # ---------------------------------------
        # Location, where the middleware layer specific platform headers are exported
        # ---------------------------------------

        defineReplace(MW_LAYER_DOMAIN_EXPORT_PATH) {
             return (/epoc32/include/domain/middleware/$$1)
        }
        defineReplace(MW_LAYER_PLATFORM_EXPORT_PATH) {
             return (/epoc32/include/domain/middleware/$$1)
        }

        # ---------------------------------------
        # Location, where the os layer specific public headers are exported
        # ---------------------------------------

        defineReplace(OSEXT_LAYER_SDK_EXPORT_PATH) {
             return (/epoc32/include/osextensions/$$1)
        }
        # WARNING: If the following path changes see the exists() function around line 430
        defineReplace(OS_LAYER_PUBLIC_EXPORT_PATH) {
             return (/epoc32/include/osextensions/$$1)
        }

        # ---------------------------------------
        # Location, where the os specific platform headers are exported
        # ---------------------------------------

        defineReplace(OSEXT_LAYER_DOMAIN_EXPORT_PATH) {
             return (/epoc32/include/domain/osextensions/$$1)
        }
        defineReplace(OS_LAYER_PLATFORM_EXPORT_PATH) {
             return (/epoc32/include/domain/osextensions/$$1)
        }

        # ---------------------------------------
        #  General comments about the 3 define statements related to include paths:
        #  1) the /epoc32/include/oem is now defined there for backward compability.
        #     Once the directory is empty, the directory will be removed. However this 
        #     enables us to ensure that if you use these define statements => you do 
        #     not have to remove the statements later on, when the directory no longer 
        #     exists.
        #  2) These statements should be enough in normal cases. For certain specific 
        #     cases you might need to add some specific directory from /epoc32/include
        #     (for instance /epoc32/include/ecom).
        #     In normal cases the include staments in code should be relative to one of 
        #     the system include paths, but in certain cases, the included files requires
        #     that the subdirectory is also part of the system include paths.
        # ---------------------------------------

        # This variable defines the include paths, which are intended to be 
        # used in the pro-files that are part of the applications-layer. It includes all 
        # the needed directories from the /epoc32/include, that are valid ones for the 
        # application-layer components. 
        #
        # Applications layer is the last one in the list, since most likely the most of 
        # the headers come from middleware or os-layer  => thus they are first.

        APP_LAYER_SYSTEMINCLUDE = \
         /epoc32/include \
         /epoc32/include/oem \
         /epoc32/include/middleware \
         /epoc32/include/domain/middleware \
         /epoc32/include/osextensions \
         /epoc32/include/domain/osextensions \
         /epoc32/include/applications \
         /epoc32/include/domain/applications \
         /epoc32/include/domain/osextensions/loc \
         /epoc32/include/domain/middleware/loc \
         /epoc32/include/domain/applications/loc \
         /epoc32/include/domain/osextensions/loc/sc \
         /epoc32/include/domain/middleware/loc/sc \
         /epoc32/include/domain/applications/loc/sc

        # This define statements defines the include paths, which are intended to be
        # used in the pro-files that are part of the middleware-layer. It includes all 
        # the needed directories from the /epoc32/include, that are valid ones for the 
        # middleware-layer components. 

        MW_LAYER_SYSTEMINCLUDE = \
         /epoc32/include \
         /epoc32/include/oem \
         /epoc32/include/middleware \
         /epoc32/include/domain/middleware \
         /epoc32/include/osextensions \
         /epoc32/include/domain/osextensions \
         /epoc32/include/domain/osextensions/loc \
         /epoc32/include/domain/middleware/loc \
         /epoc32/include/domain/osextensions/loc/sc \
         /epoc32/include/domain/middleware/loc/sc

        # This define statements defines the include paths, which are intended to be
        # used in the pro-files that are part of the  osextensions-layer. It includes all
        # the needed directories from the /epoc32/include, that are valid ones for the
        # os-layer components. 

        OS_LAYER_SYSTEMINCLUDE = \
         /epoc32/include \
         /epoc32/include/oem \
         /epoc32/include/osextensions \
         /epoc32/include/domain/osextensions \
         /epoc32/include/domain/osextensions/loc \
         /epoc32/include/domain/osextensions/loc/sc

        # This define statements defines the include paths, which are intended to be
        # used in the pro-files that are part of the os-layer. This is intended 
        # to be only used by those components which need to use in their mmp-file either
        # kern_ext.mmh or nkern_ext.mmh. Reason is that those
        # 2 files already contain the /epoc32/include  as system include path.

        OS_LAYER_KERNEL_SYSTEMINCLUDE = \
         /epoc32/include/oem \
         /epoc32/include/osextensions \
         /epoc32/include/domain/osextensions


        # ---------------------------------------
        # Definitions that also define the systeminclude paths for various
        # part of stdapis. Append to INCLUDEPATH in pro-file.
        # ---------------------------------------

        OS_LAYER_LIBC_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/sys) \
                                      /epoc32/include/stdapis \
                                      /epoc32/include/stdapis/sys

        OS_LAYER_GLIB_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/glib-2.0) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/glib-2.0/glib) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/glib-2.0/gObject) \
                                      /epoc32/include/stdapis/glib-2.0 \
                                      /epoc32/include/stdapis/glib-2.0/glib \
                                      /epoc32/include/stdapis/glib-2.0/gObject

        OS_LAYER_SSL_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/openssl) \
                                     /epoc32/include/stdapis/openssl

        # stlportv5 is preferred over stlport as it has the throwing version of operator new
        OS_LAYER_STDCPP_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/stlportv5) \
                                        /epoc32/include/stdapis/stlportv5
        exists($${EPOCROOT}epoc32/include/osextensions/stdapis/stlport) \
        |exists($${EPOCROOT}epoc32/include/stdapis/stlport) {
            !exists($${EPOCROOT}epoc32/include/osextensions/stdapis/stlportv5) \
            :!exists($${EPOCROOT}epoc32/include/stdapis/stlportv5) {
                OS_LAYER_STDCPP_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/stlport) \
                                                /epoc32/include/stdapis/stlport
            }
        }
        
        OS_LAYER_BOOST_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/boost) \
                                       /epoc32/include/stdapis/boost

        OS_LAYER_DBUS_SYSTEMINCLUDE = $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/dbus-1.0) \
                                      $$OS_LAYER_PUBLIC_EXPORT_PATH(stdapis/dbus-1.0/dbus) \
                                      /epoc32/include/stdapis/dbus-1.0 \
                                      /epoc32/include/stdapis/dbus-1.0/dbus

        OS_LAYER_LIBUTILITY_SYSTEMINCLUDE = $$OS_LAYER_PLATFORM_EXPORT_PATH(stdapis/utility) \
                                            /epoc32/include/stdapis/utility

    } 

    # Definitions common to both structures

    # ---------------------------------------
    # Definitions to export IBY files to different folders where they will be taken
    # to ROM image
    # ---------------------------------------

    defineReplace(CORE_APP_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/core/app/$$1)
    }
    defineReplace(CORE_MW_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/core/mw/$$1)
    }

    defineReplace(LANGUAGE_APP_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/language/app/$$1)
    }
    defineReplace(LANGUAGE_MW_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/language/mw/$$1)
    }

    defineReplace(CUSTOMER_APP_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/customer/app/$$1)
    }
    defineReplace(CUSTOMER_MW_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/customer/mw/$$1)
    }

    defineReplace(CUSTOMER_VARIANT_APP_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/customervariant/app/$$1)
    }
    defineReplace(CUSTOMER_VARIANT_MW_LAYER_IBY_EXPORT_PATH) {
        return(/epoc32/rom/include/customervariant/mw/$$1)
    }

    # You need to define the following in pro-file, if you are using the stllib:
    # QMAKE_CXXFLAGS.CW *= $$STLLIB_USAGE_CW_FLAGS
    # DEFINES *= $$STLLIB_USAGE_DEFINES
    STLLIB_USAGE_CW_FLAGS = "-wchar_t on"
    STLLIB_USAGE_DEFINES = _WCHAR_T_DECLARED

}