1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // Symbian_OS.hrh

    15 // Configuration options for Symbian OS

    16 // This file is managed by the Master Codeline Forum

    17 

    18 /** This include is for PREQ2621 */

    19 #include "platform_paths.hrh"

    20 

    21 // SYMBIAN_JAVA_NOT_INCLUDED

    22 // For Sphinx and later versions, J2ME will no longer be included in the 

    23 // build.  

    24 // This #define supports PREQ1791

    25 // 

    26 //

    27 

    28 /**

    29  @publishedPartner

    30  @released

    31 */

    32 #define SYMBIAN_JAVA_NOT_INCLUDED

    33    

    34 /**

    35 @publishedPartner

    36 @released

    37 

    38 SYMBIAN_HCI_API_V2

    39                     

    40 If SYMBIAN_HCI_API_V2 is defined then the HCI APIs provided in PREQ750 

    41 (Bluetooth HCI improvements) will be required for use by a version 2 

    42 Bluetooth Stack and a version 2 HCI. These APIs are neither binary nor 

    43 source compatible with the previous version 1 HCI APIs. Both the original 

    44 version 1  Bluetooth stack and HCI, and the new version 2 Bluetooth stack 

    45 and HCI will be built, but both rombuild and the emulator will be 

    46 configured to use the version 2 binaries. The version 2 HCI will support 

    47 all commands and events listed in Bluetooth v2.0 specification.

    48 

    49 If SYMBIAN_HCI_API_V2 is not defined then only the version 1 Bluetooth 

    50 stack and HCI will be built and used by rombuild and the emulator.

    51 The version 1 HCI supports most but NOT all commands and events listed 

    52 in Bluetooth v2.0 specification.

    53 

    54 See BR1613 for more information.

    55 */

    56 #define SYMBIAN_HCI_API_V2

    57 

    58 /**

    59 @publishedAll

    60 @released

    61 

    62 __WATCHER_API_V2__

    63 

    64 If __WATCHER_API_V2__ is defined then the 

    65 watcher framework supports ECOM watcher plugins.

    66 */

    67 #define __WATCHER_API_V2__

    68 

    69 /**

    70 @publishedAll

    71 @released

    72 

    73 __HIDE_WATCHER_API_V1__

    74 

    75 Hides support APIs for loading non-ECOM watcher plugins. Non-ECOM watcher 

    76 plugins are still loaded. The associated define __REMOVE_WATCHER_API_V1__

    77 removes the implementation of the support APIs.

    78 

    79 Assumes that __WATCHER_API_V2__ has been defined.

    80 */

    81 #define __HIDE_WATCHER_API_V1__

    82 #define __REMOVE_WATCHER_API_V1__

    83 

    84 /**

    85 SYMBIAN_TIMEZONE_SUPPORT_V1

    86 

    87 @publishedAll

    88 @released

    89 

    90 When SYMBIAN_TIMEZONE_SUPPORT_V1 is defined the App-services TzClient.dll 

    91 module (and accompanying import library) is made available for client 

    92 application use.

    93 

    94 This #define supports PREQ663

    95 */

    96 #define SYMBIAN_TIMEZONE_SUPPORT_V1

    97 

    98 /** 

    99 @publishedAll

   100 @released

   101 

   102 SYMBIAN_ENABLE_MMF_MULTISCREEN_SUPPORT

   103 

   104 If SYMBIAN_ENABLE_MMF_MULTISCREEN_SUPPORT is defined then 

   105 the Multimedia Framework (MMF) can support video playback on 

   106 a secondary display. The default screen will be the screen 

   107 number in the cone environment.

   108 

   109 @see CVideoPlayerUtility

   110 */

   111 #define SYMBIAN_ENABLE_MMF_MULTISCREEN_SUPPORT

   112 

   113 /**

   114 @publishedAll

   115 @released

   116 

   117 SYMBIAN_EXTENDED_COMPOSITE_FILESYSTEM

   118 

   119 If  SYMBIAN_EXTENDED_COMPOSITE_FILESYSTEM is defined, the Composite

   120 File System allows more than one ROFS partition to be included in

   121 the composite Z: drive.

   122 

   123 This #define supports PREQ1085

   124 */

   125 #define SYMBIAN_EXTENDED_COMPOSITE_FILESYSTEM

   126 

   127 /**

   128 @publishedPartner

   129 @released

   130 

   131 __SECURE_BIN__

   132 

   133 When __SECURE_BIN__ is defined, executable files stored as

   134 "data" in the XIP ROM are assumed to be in their data-caged 

   135 locations. The presence of this #define does not imply that 

   136 data-caging is enforced, and does not imply that binaries have 

   137 been relocated to sys\bin.

   138 

   139 This #define supports PREQ537 "Platform security - file system layout".

   140 */

   141 #define __SECURE_BIN__

   142 

   143 /**

   144 @publishedAll

   145 @released

   146 

   147 SYMBIAN_COREAPPS_API_V2

   148 

   149 If SYMBIAN_COREAPPS_API_V2 is defined then new functionality is available within 

   150 the Core Apps sub-system (Contacts Model, Agenda Model and World Server) to 

   151 support a platform secured OS.

   152 */

   153 #define SYMBIAN_COREAPPS_API_V2

   154 

   155 /**

   156 @publishedPartner

   157 @released

   158 

   159 SYMBIAN_APPARC_APPINFO_CACHE

   160 

   161 If SYMBIAN_APPARC_APPINFO_CACHE is defined then apparc creates 

   162 a file of application information on the first boot, which is 

   163 used during subsequent boots for application information.

   164 */

   165 #define SYMBIAN_APPARC_APPINFO_CACHE

   166 

   167 /**

   168 @publishedPartner

   169 @released

   170 

   171 SYMBIAN_NETWORKING_IPSEC_IKE_V2

   172 

   173 If SYMBIAN_NETWORKING_IPSEC_IKE_V2 is defined, IPSEC will 

   174 be able to support Internet Key Exchange version 2 in 

   175 addition to IKE v1. This involves a change in the size of 

   176 the TPfkeyMsgBase class - see BR1736.1.

   177 

   178 Actual support for IKE v2 will depend on the provision 

   179 of a suitable plugin to the Key Management Daemon.

   180 

   181 This #define supports PREQ1223.

   182 */

   183 #define SYMBIAN_NETWORKING_IPSEC_IKE_V2

   184 

   185 /**

   186 @publishedPartner

   187 @released

   188 

   189 SYMBIAN_UIKON_UNIFICATION

   190 

   191 When SYMBIAN_UIKON_UNIFICATION is defined, the existing 

   192 CEikSrvAppUiBase class is replaced with a customisable class

   193 provided by the System GUI. 

   194 

   195 This #define supports PREQ819 and PREQ826

   196 */

   197 #define SYMBIAN_UIKON_UNIFICATION

   198 

   199 /**

   200 @publishedAll

   201 @released

   202 

   203 __SECURITY_PLATSEC_ARCH__

   204 

   205 If this macro is defined, then platform security aware security services 

   206 APIs will be present.  This includes architectural changes to several 

   207 components.

   208 

   209 If this macro is not defined, the original version (since 8.0) of the 

   210 security services APIs will be present. 

   211 

   212 The following components are affected:

   213   cryptotokens

   214   certman

   215   filetokens

   216 

   217 */

   218 #define __SECURITY_PLATSEC_ARCH__

   219 

   220 /**

   221 SYMBIAN_ECAM_CHUNKAPI

   222 

   223 @publishedAll

   224 @released

   225 

   226 Specifies that an extended API will be used in the multimedia 

   227 camera interface. This has a v2 observer which allows camera data 

   228 to be returned without buffer copy, and also allows clients to set 

   229 camera access priority

   230 

   231 @see CCamera

   232 @see MCameraObserver2

   233 

   234 This #define supports PREQ799.

   235 */

   236 #define SYMBIAN_ECAM_CHUNKAPI

   237 

   238 /**

   239 @publishedAll

   240 @released

   241 

   242 SYMBIAN_SECURE_ECOM

   243 

   244 When SYMBIAN_SECURE_ECOM is not defined, ECOM plugins are discovered by 

   245 searching for DLLs in System\libs\plugins, and inferring the name of 

   246 the resource file from the UID3 of the DLL.

   247 

   248 When SYMBIAN_SECURE_ECOM is defined, ECOM plugins will also be discovered

   249 by searching for resource files in \Resource\Plugins, and inferring the

   250 name of the DLL from the name of the resource file. When platform security

   251 is fully enforced, only this new style of discovery will work.

   252 */

   253 #define SYMBIAN_SECURE_ECOM

   254 

   255 /**

   256 @publishedAll

   257 @released

   258 

   259 SYMBIAN_INETPROTUTILS_RFC3986

   260 

   261 Description:

   262 If SYMBIAN_INETPROTUTILS_RFC3986 is defined, the Internet 

   263 Protocol Utility Library supports RFC 3986, which increases 

   264 the set of reserved characters.

   265 

   266 @see EscapeUtils::IsExcludedChar

   267 

   268 This #define implements BR2009.

   269 */

   270 #define SYMBIAN_INETPROTUTILS_RFC3986

   271 

   272 /**

   273 @publishedPartner

   274 @released

   275 

   276 SYMBIAN_FONT_METRICS_V2 

   277 

   278 If this is defined, then classes which derive from COpenFont (usually 

   279 these are part of a font rasterizer implementation) must set the 

   280 protected member variables:

   281 iFontAscentOfCapitals

   282 iFontAscentIncAccents

   283 iFontDescent

   284 iFontLineGap

   285 to appropriate values during the creation of a font. 

   286 If this macro is not defined then these member variables do not exist.

   287 

   288 @see COpenFont

   289 */

   290 #define SYMBIAN_FONT_METRICS_V2

   291 

   292 /**

   293 @publishedAll

   294 @released

   295 

   296 __OBEX_USER_DEFINED_HEADERS__

   297 

   298 If __OBEX_USER_DEFINED_HEADERS__ is defined then the new API support for extended Headers will be available.

   299 This new support includes USER DEFINED HEADERS and the COUNT header.

   300 If this functionality is compiled out then the old API is available as before.

   301 For more information on see documents shown below.

   302 

   303 @see SGL.GT171.097 - Obex Header Extension how to

   304 @see SGL.GT171.095 - Obex Extension Design Document

   305 */

   306 #define __OBEX_USER_DEFINED_HEADERS__

   307 

   308 /**

   309 @publishedPartner

   310 @released

   311 

   312 SYMBIAN_CENTREP_NOC

   313 

   314 If SYMBIAN_CENTREP_NOC is defined, the Central Repository 

   315 includes Notify-Only Client Optimization. This will cause 

   316 repositories to be unloaded after a timeout even if the 

   317 connection is still open.

   318 

   319 This #define supports PREQ1228. 

   320 */

   321 #define SYMBIAN_CENTREP_NOC

   322 

   323 /**

   324 @publishedPartner

   325 @released

   326 @since 8.1

   327 

   328 SYMBIAN_BLUETOOTH_REQUIRES_HCI_FLUSH_COMPLETE_EVENT 

   329 

   330 If this is defined, the MHCIEventObserver class must implement

   331 the FlushCompleteEvent virtual function, which will be used by 

   332 the link manager to send Flush Complete events up to the stack. 

   333 If this macro is not defined, Flush Complete events will be discarded.

   334 

   335 @see MHCIEventObserver

   336 @see CHCIFacade

   337 */

   338 #define SYMBIAN_BLUETOOTH_REQUIRES_HCI_FLUSH_COMPLETE_EVENT

   339 

   340 /**

   341 @publishedAll

   342 @released

   343 

   344 SYMBIAN_MULTIMEDIA_CODEC_API

   345 

   346 If SYMBIAN_MULTIMEDIA_CODEC_API is defined then support is 

   347 available for PREQ1024 delivered Processing Unit or 

   348 OpenMAX based codecs and Multimedia hardware devices.

   349 */

   350 #define SYMBIAN_MULTIMEDIA_CODEC_API

   351 /** 

   352 @publishedAll

   353 @released

   354 

   355 

   356 SYMBIAN_MULTIMEDIA_SUBTITLE_SUPPORT 

   357 

   358 Provides support control the presentation of subtitle and closed captioning text

   359 from video playback controllers in the Multimedia Framework as part of @see CVideoPlayerUtility2.

   360 Note that this support is dependent on the following being present in ROM: 

   361 - GCE version of Graphics (migration component)

   362 - GCE version of Videorender (optional component).

   363 - The Subtitle plugin (optional component). 

   364 

   365 This #define supports PREQ1939 

   366 */ 

   367 #define SYMBIAN_MULTIMEDIA_SUBTITLE_SUPPORT

   368 

   369 /**

   370 @publishedAll

   371 @released

   372 

   373 __MESSAGING_API_V2__

   374 

   375 If __MESSAGING_API_V2__ is defined then new functionality 

   376 is available within the Messaging sub-system to support a 

   377 platform secured OS, e.g. the Attachment API.

   378 */

   379 #define __MESSAGING_API_V2__

   380 #define __HIDE_MESSAGING_API_V1__

   381 #define __REMOVE_MESSAGING_API_V1__

   382 

   383 /**

   384 @publishedPartner

   385 @released

   386 

   387 SYMBIAN_BOOKMARK_DATABASE

   388 

   389 The Bookmark Database is an API used to provide system-wide 

   390 storage and management functionality for URI bookmarks. 

   391 If defined, this macro indicates that the Bookmark Database 

   392 API is present in the platform.

   393 */

   394 #define SYMBIAN_BOOKMARK_DATABASE

   395 

   396 /**

   397 @publishedPartner

   398 @released

   399 

   400 SYMBIAN_NETWORKING_UMTSR5

   401 

   402 If SYMBIAN_NETWORKING_UMTSR5 is defined support for the QoS 

   403 and IMS parameters introduced by Release 5 of the 3GPP 

   404 specification will be enabled. This involves a BC break in 

   405 TContextConfig - see BR1582.1 for details.

   406 

   407 @see TContextConfig

   408 

   409 This #define supports PREQ192 and PREQ635.

   410 */

   411 #define SYMBIAN_NETWORKING_UMTSR5

   412 

   413 /**

   414 @publishedPartner

   415 @released

   416 

   417 SYMBIAN_NETWORKING_3GPPDEFAULTQOS

   418 

   419 If SYMBIAN_NETWORKING_3GPPDEFAULTQOS is defined, support 

   420 for QoS modification on the default PDP context will be 

   421 enabled via the RSubconnection API.

   422 

   423 This #define supports PREQ870.

   424 */

   425 #define SYMBIAN_NETWORKING_3GPPDEFAULTQOS

   426 

   427 

   428 /**

   429 SYMBIAN_STAGED_SYSTEM_STARTUP

   430 

   431 @publishedPartner

   432 @released

   433 

   434 When SYMBIAN_STAGED_SYSTEM_STARTUP is defined, the staged 

   435 start-up architecture has been introduced into the OS and 

   436 'Start-up State Aware' components can make use of the 

   437 architecture.

   438 

   439 This #define supports PREQ 810.

   440 */

   441 #define SYMBIAN_STAGED_SYSTEM_STARTUP

   442 

   443 /**

   444 @publishedAll

   445 @released

   446 

   447 __HIDE_IPC_V1__

   448 

   449 If __HIDE_IPC_V1__ is defined then the deprecated insecure IPC APIs will be removed from various Symbian OS header files. Classes affected include CSession, CServer, RMessage and RMessageptr.

   450 

   451 For more information see the document listed below.

   452 

   453 @see SMG.SM0005.004 - Platform Security Development for Zephyr

   454 @see CSession

   455 @see CServer

   456 @see RMessage

   457 @see RMessagePtr

   458 */

   459 #define __HIDE_IPC_V1__

   460 

   461 /**

   462 @publishedPartner

   463 @released

   464 

   465 SYMBIAN_NETWORKING_DHCPSERVER

   466 

   467 If SYMBIAN_NETWORKING_DHCPSERVER is defined, Symbian OS includes a

   468 simplified DHCPv4 server capable of dealing with single client.

   469 

   470 This #define provides functionality to support PREQ749.

   471 */

   472 #define SYMBIAN_NETWORKING_DHCPSERVER

   473 

   474 /**  

   475 @publishedAll 

   476 @released

   477 

   478 SYMBIAN_REMOVE_TRIVIAL_ENCRYPTION

   479 

   480 This macro removes the trivial encryption APIs that are exported by EUSER. 

   481 

   482 See BR1320 for more details

   483 

   484 */

   485 #define SYMBIAN_REMOVE_TRIVIAL_ENCRYPTION

   486 

   487 /**

   488 @internalTechnology

   489 

   490 SYMBIAN_WAPPUSH_WHITELIST_BLACKLIST

   491 

   492 Description:

   493 If SYMBIAN_WAPPUSH_WHITELIST_BLACKLIST is defined, the WAP Push

   494 watcher compares the origin of Push messages against URIs in a

   495 "White list" and "Black list".

   496 

   497 This #define supports PREQ1505

   498 */

   499 #define SYMBIAN_WAPPUSH_WHITELIST_BLACKLIST

   500 

   501 /**

   502 @publishedPartner

   503 @released

   504 

   505 SYMBIAN_FLEXIBLE_ALARM

   506 

   507 When this macro is defined, Calendar Interim API, Alarm server and UIKON 

   508 Alert Server will support additional functionality.

   509 - Extra data can be attached to calendar alarm and allow UI app 

   510 to retrieve the associated data.

   511 - The Alarm server can send multiple expired alarms to Alert Server without 

   512 waiting for the previous alarm acknowledged first

   513 - A Resource file can be used to configure alarm play intervals and durations, 

   514 or to disable alarm sound control.

   515 

   516 This #define supports PREQ1118

   517 */

   518 #define SYMBIAN_FLEXIBLE_ALARM

   519 

   520 /**

   521 @publishedPartner

   522 @released

   523 

   524 SYMBIAN_PKCS12

   525 

   526 If SYMBIAN_PKCS12 is defined, the PKCS#12 Key Derivation 

   527 Algorithm is supplied.

   528 

   529 This #define supports PREQ1054. 

   530 */

   531 #define SYMBIAN_PKCS12

   532 

   533 /**

   534 @publishedAll

   535 @released

   536 

   537 SYMBIAN_MMF_AUTOPAUSE_RESUME

   538 

   539 This #define enables extra features in the MMF APIs for auto pause 

   540 and resume of audio streams.

   541 */

   542 #define SYMBIAN_MMF_AUTOPAUSE_RESUME

   543 

   544 /**

   545 @publishedAll

   546 @released

   547 

   548 __SECURE_BACKUP__

   549 

   550 If __SECURE_BACKUP__ is defined, the Secure Backup server replaces

   551 the use of SCRemFs for backup and restore, changing the backup protocol.

   552 Applications which have private data need to provide additional backup 

   553 registration files, and may use Publish & Subscribe to receive 

   554 notification of backup requests.

   555 

   556 This #define supports PREQ716 - Provide support for secure backup and 

   557 restore for licensee PC Connectivity software 

   558 */

   559 #define __SECURE_BACKUP__

   560 

   561 /** 

   562 @publishedAll

   563 @released

   564 

   565 SYMBIAN_NETWORKING_REMOVE_RGENERIC

   566 

   567 If this macro is defined the deprecated APIs RGenericAgent, 

   568 RNif, RNifMonitor and Nifman are removed. All of these APIs, 

   569 exported by NIFMAN, have been deprecated and replaced by 

   570 the RConnection API exported by ESOCK.

   571 

   572 @see Break request BR1070 

   573 */ 

   574 #define SYMBIAN_NETWORKING_REMOVE_RGENERIC

   575 

   576 /**

   577 @publishedPartner

   578 @released 9.0

   579 

   580 SYMBIAN_NETWORKING_RSUBCONNECTION

   581 

   582 If SYMBIAN_NETWORKING_RSUBCONNECTION is defined, the RQosChannel API is

   583 removed, and the RSubConnection API exported by ESOCK must be used instead.

   584 

   585 This #define supports PREQ 26.

   586 */ 

   587 #define SYMBIAN_NETWORKING_RSUBCONNECTION

   588 

   589 /**

   590 @publishedAll

   591 @released

   592 

   593 SYMBIAN_HIDE_COREAPPS_API_V1

   594 

   595 If SYMBIAN_HIDE_COREAPPS_API_V1 is defined then the insecure CoreApps APIs

   596 will be removed from various Symbian OS header files. Components affected are 

   597 Contacts Model, Agenda Model and World Server.

   598 

   599 The related define SYMBIAN_REMOVE_COREAPPS_API_V1 removes the underlying implementations,

   600 causing a binary compatibility break to match the source compatibility break.

   601 */

   602 #define SYMBIAN_HIDE_COREAPPS_API_V1

   603 #define SYMBIAN_REMOVE_COREAPPS_API_V1

   604 

   605 /**

   606 @publishedAll

   607 @released

   608 

   609 __UI_FRAMEWORKS_V2__

   610 

   611 If __UI_FRAMEWORKS_V2__ is defined then PlatSec aware UI Frameworks API's will be available. 

   612 The following frameworks will be affected:

   613 

   614 Applications 

   615 File Recognizers

   616 Data Recognizers

   617 Notifiers

   618 Control Panel Plugins

   619 Feps

   620 App-initialization (CEikLibrary)

   621 Converters

   622 Error-Resolving

   623 */

   624 #define __UI_FRAMEWORKS_V2__

   625 #define SYMBIAN_HIDE_UI_FRAMEWORKS_V1

   626 #define SYMBIAN_REMOVE_UI_FRAMEWORKS_V1

   627 

   628 /**

   629 @internalAll

   630 

   631 __BC_FUTURE_PROOFING__

   632 

   633 Support for the implementation of PREQ743 "Introduction of interface 

   634 robustness patterns to support future binary compatibility".

   635 */

   636 #define __BC_FUTURE_PROOFING__

   637 

   638 /** 

   639 @publishedPartner 

   640 @released

   641 

   642 SYMBIAN_TELEPHONY_USAT5 

   643 

   644 If SYMBIAN_TELEPHONY_USAT5 is defined then support for 3GPP 

   645 Release 5 (U)SAT will be enabled. 

   646 

   647 @see RSat::TCallControlV5

   648 

   649 This #define supports PREQ1234.

   650 */ 

   651 #define SYMBIAN_TELEPHONY_USAT5

   652 

   653 /**

   654 SYMBIAN_GENERIC_SYSTEM_STARTUP

   655 

   656 @publishedPartner

   657 @released

   658 

   659 This #define enables the generic start-up architecture in

   660 which the System Starter process is responsible for the

   661 controlled startup of the system. 

   662 

   663 The #define supports PREQ808 and PREQ809.

   664 */

   665 #define SYMBIAN_GENERIC_SYSTEM_STARTUP

   666 

   667 /**

   668 @publishedAll

   669 @released

   670 

   671 SYMBIAN_SECURE_PUBLISH_AND_SUBSCRIBE

   672 

   673 If this macro is defined, then the Bluetooth stack reconfigures to take

   674 advantage of security mechanisms in Publish and Subscribe. Any other

   675 components requiring reconfiguration to make use of Publish and Subscribe

   676 can also use this macro.

   677 

   678 */

   679 #define SYMBIAN_SECURE_PUBLISH_AND_SUBSCRIBE

   680 

   681 /**

   682 @publishedAll

   683 @released

   684 

   685 SYMBIAN_SECURITY_CAF_RFILE_HANDLE

   686 

   687 If SYMBIAN_SECURITY_CAF_RFILE_HANDLE is defined then it enables the Content Access 

   688 Framework to read from files passed to it as an open RFile handles instead of CAF 

   689 opening the file itself. This allows files stored in a data caged directory to be 

   690 read by CAF.  

   691 

   692 */

   693 #define SYMBIAN_SECURITY_CAF_RFILE_HANDLE

   694 

   695 /**

   696 @publishedAll

   697 @released

   698 

   699 __JAVACUSTOMINSTALL__

   700 

   701 If __JAVACUSTOMINSTALL__ is defined then an additional UI callback is made after MIDlet

   702 installation has succeeded or failed. This callback is intended for information only and the 

   703 information passed can be licensee customised. The intention would be that the device user

   704 can use this information to diagnose install problems in conjunction with network operators.

   705 If this #define is not present then the callback is not present and is not called.

   706 For more information on see documents shown below.

   707 

   708 @see SGL.GT0188.253 CDMA Java MIDlet Installer Component Design

   709 */

   710 #define __JAVACUSTOMINSTALL__

   711 

   712 /**  

   713 @publishedAll 

   714 @released

   715 

   716 SYMBIAN_MDF_API_V2 

   717 

   718 This macro selects the Symbian OS 9.x phase of development in 

   719 the Media Device Framework API, including changes to enable 

   720 MDF Video Decoder Hardware devices to support applications, 

   721 streaming and demux.

   722 

   723 @see CMMFVideoPlayHwDevice

   724 */ 

   725 #define SYMBIAN_MDF_API_V2

   726 

   727 /**

   728 @publishedPartner

   729 @released

   730 

   731 SYMBIAN_SMS_REL6_SUPPORT

   732 

   733 SMS Release 6 support is defined in the 3GPP specifications

   734 (3GPP TS 23.040 V6.5.0 and 3GPP TS 23.038 V6.1.0).

   735 If defined, this macro indicates that Symbian OS SMS APIs

   736 shall support Release 6 functionality.

   737 */

   738 #define SYMBIAN_SMS_REL6_SUPPORT

   739 

   740 /**

   741 @publishedPartner

   742 @released

   743 

   744 SYMBIAN_SWI_POST_INSTALL_REVOCATION

   745 

   746 When SYMBIAN_SWI_POST_INSTALL_REVOCATION is defined, 

   747 support for the SWI post install revocation service is enabled.

   748 

   749 This #define supports PREQ919

   750 */

   751 #define SYMBIAN_SWI_POST_INSTALL_REVOCATION

   752 

   753 /**

   754 @publishedPartner

   755 @released

   756 

   757 SYMBIAN_TELEPHONY_IMS

   758 

   759 If SYMBIAN_TELEPHONY_IMS is defined then IMS related APIs are included 

   760 in Telephony components.

   761 

   762 This #define supports PREQ61.

   763 */

   764 #define SYMBIAN_TELEPHONY_IMS

   765 

   766 /**

   767 @publishedPartner

   768 @released

   769 

   770 SYMBIAN_IGNORE_BIN_TARGETPATH

   771 

   772 When SYMBIAN_IGNORE_BIN_TARGETPATH is defined the TARGETPATH keyword in MMP files is ignored for executables. 

   773 Executables for the emulator instead get built to the default location.

   774 e.g. \epoc32\release\winscw\udeb

   775 */

   776 #define SYMBIAN_IGNORE_BIN_TARGETPATH

   777 

   778 /**

   779 @publishedAll 

   780 @released

   781 

   782 SYMBIAN_COMMS_REPOSITORY

   783 

   784 Comms data is now stored in the Central Repository rather than the DBMS server.  

   785 A new module, CommsDat.dll, replaces Commdb.dll as the interface for comms data stored on a device. 

   786 CommsDat has a different API to Commdb, but provides equivalent functionality. 

   787 There is no longer an SQL API for access to Comms Data. 

   788 Commdb tools have been migrated for use with CommsDat 

   789 Commdb is deprecated and should not be used, though it remains as a temporary BC shim on top of CommsDat.   

   790 */

   791 #define SYMBIAN_COMMS_REPOSITORY

   792 

   793 /**

   794 @publishedAll

   795 @released

   796 

   797 SYMBIAN_VARIABLE_BITRATE_CODEC

   798 

   799 If SYMBIAN_VARIABLE_BITRATE_CODEC is defined then 

   800 CMMFSwCodecWrapper based audio hardware devices in the 

   801 Multimedia Framework (MMF) can support variable bitrate codecs.

   802 

   803 @see CMMFSwCodecWrapper

   804 */

   805 #define SYMBIAN_VARIABLE_BITRATE_CODEC

   806 

   807 /**

   808 @publishedAll

   809 @released

   810 

   811 __SECURE_TELEPHONY__

   812 

   813 If __SECURE_TELEPHONY__ is defined, all Platform Security functionality 

   814 within the Telephony subsystem will be enabled.

   815 If __SECURE_TELEPHONY__ is not defined, no Platform Security functionality 

   816 within the Telephony subsystem is enabled.

   817 */

   818 #define __SECURE_TELEPHONY__

   819 

   820 /**

   821 @publishedPartner

   822 @released

   823 

   824 SYMBIAN_CAF_V2

   825 

   826 The SYMBIAN_CAF_V2 flag indicates the CAF API v2 is present. 

   827 CAF v2 supports files containing multiple content objects, which requires 

   828 a change of API for CAF agents: agents written for CAF v1 will not compile

   829 against CAF v2. See BR.1219.2 for migration information.

   830 

   831 This #define supports PREQ780.

   832 */

   833 #define SYMBIAN_CAF_V2

   834 

   835 /**

   836 SYMBIAN_ROM_STATIC_PLUGIN_INFORMATION

   837 

   838 @publishedPartner

   839 @released

   840 

   841 This macro enables a consolidation phase in the ROM building 

   842 process to generate additional metadata for each ROM drive.  

   843 The metadata describes the content and structure of the ROM 

   844 conveniently filtered for any component that requires it.

   845 

   846 Components supply metadata with the "spidata" BUILDROM keyword.

   847 

   848 This macro supports PREQ806 and other requirements that 

   849 eliminate run-time scanning of ROM content.

   850 */

   851 #define SYMBIAN_ROM_STATIC_PLUGIN_INFORMATION

   852 

   853 /**

   854 @publishedPartner

   855 @released

   856 

   857 SYMBIAN_BLUETOOTH_ESCO_ENABLED

   858 

   859 Enable support for Bluetooth eSCO synchronous links.  

   860 Defining this macro extends the interface to CHCIBase to support 

   861 the Synchronous connection commands added in Bluetooth 1.2.

   862 */

   863 #define SYMBIAN_BLUETOOTH_ESCO_ENABLED

   864 

   865 /**

   866 @publishedPartner

   867 @released

   868 

   869 SYMBIAN_SECURE_MIDLET_INSTALL

   870 

   871 If SYMBIAN_SECURE_MIDLET_INSTALL is defined then the Java MIDlet 

   872 Installer supports installation under Platform Security policies, 

   873 using the interface published by security\JavaMIDletInstaller.

   874 

   875 If SYMBIAN_SECURE_MIDLET_INSTALL is not defined then Java MIDlet 

   876 installation is achieved through the security\appinst interfaces.

   877 */

   878 #define SYMBIAN_SECURE_MIDLET_INSTALL

   879 

   880 /**

   881 @publishedAll

   882 @released

   883 

   884 SYMBIAN_UI_FRAMEWORKS_CONTROL_API_V2

   885 

   886 If SYMBIAN_UI_FRAMEWORKS_CONTROL_API_V2 is defined then 

   887 the following additional features will be available in CONE.

   888 1) Functions to set and get the background of a control.

   889 2) Functions to add components to a compound control in a simpler way.

   890 3) Hooks for the support of layout managers.

   891 4) A component that will provide fonts and cache them for easier use 

   892    of these fonts by controls.

   893 

   894 @see CCoeControl

   895 */

   896 #define SYMBIAN_UI_FRAMEWORKS_CONTROL_API_V2

   897 

   898 /**

   899 @publishedAll

   900 @released

   901 

   902 SYMBIAN_CNTMODEL_V2

   903 

   904 If SYMBIAN_CNTMODEL_V2 is defined, clients of the

   905 Contacts Model can exploit the efficiency improvements

   906 introduced by PREQ811, e.g. efficient use of transactions. 

   907 

   908 This #define supports PREQ811

   909 */

   910 #define SYMBIAN_CNTMODEL_V2

   911 

   912 /**

   913 @publishedAll

   914 @released

   915 

   916 SYMBIAN_COREAPPS_PLUGIN_API_V2

   917 

   918 If SYMBIAN_COREAPPS_PLUGIN_API_V2 is defined then  Ecom solely is used as loading 

   919 mechanism.The legacy plugin loading mechanism is used otherwise.

   920 */

   921 #define SYMBIAN_COREAPPS_PLUGIN_API_V2

   922 

   923 /**

   924 @internalAll

   925 

   926 DO_NOT_USE_THIS_MACRO

   927 

   928 If DO_NOT_USE_THIS_MACRO is defined, assume the Cedar platform.

   929 If DO_NOT_USE_THIS_MACRO is not defined, assume the Beech platform.

   930 

   931 This macro was originally introduced as a stopgap measure, to

   932 identify differences between Symbian OS v7.0s and Symbian OS v8.0b

   933 which were not specifically to do with the change from Kernel

   934 Architecture 1 to Kernel Architecture 2.

   935 

   936 This macro will be deprecated when a suitable alternative is provided.

   937 */

   938 #ifndef DO_NOT_USE_THIS_MACRO

   939 #define DO_NOT_USE_THIS_MACRO

   940 #endif

   941 

   942 /** 

   943 @publishedPartner

   944 @released

   945 

   946 SYMBIAN_C32ROOT_API_V2

   947 

   948 Strengthens the C32Root API and extends it to include 

   949 configuration of queue length for bindings. 

   950 

   951 This #define supports PREQ318.

   952 */

   953 #define SYMBIAN_C32ROOT_API_V2

   954 

   955 /**

   956 @publishedAll

   957 @released

   958 

   959 __SECURE_API__

   960 

   961 Hides unsecure APIs. Many of these have been replaced by Secure variants 

   962 but some are no longer available in a Secure platform.

   963 

   964 e.g.

   965 

   966 @see User::RenameThread

   967 @see User::CommandLine

   968 

   969 */

   970 #define __SECURE_API__

   971 #define SYMBIAN_REMOVE_INSECURE_API

   972 

   973 /**

   974 @publishedAll

   975 @released

   976 

   977 __CNF_FORMAT_V2__

   978 

   979 If __CNF_FORMAT_V2__ is defined, assume that Epoccnf.pl generates

   980 files in version 2 of the CNF format, and that both versions 1

   981 and 2 of this file format can be read by Conarc.

   982 If __CNF_FORMAT_V2__ is not defined, assume that Epoccnf.pl

   983 generates files in version 1 of the CNF format, and that only

   984 version 1 of this file format can be read by Conarc.

   985 */

   986 #define __CNF_FORMAT_V2__

   987 

   988 /** 

   989 @publishedPartner 

   990 @released

   991 

   992 SYMBIAN_SUPPORT_LINKED_FONTS 

   993 

   994 If SYMBIAN_SUPPORT_LINKED_FONTS is defined then APIs are provided 

   995 to create 'linked' font instances which combine glyph sets from 

   996 multiple existing font glyph sets.

   997 

   998 @see CLinkedTypefaceElement

   999 @see CLinkedTypefaceSpecification

  1000 

  1001 This #define supports PREQ1431.

  1002 */ 

  1003 #define SYMBIAN_SUPPORT_LINKED_FONTS

  1004 

  1005 /**

  1006 @publishedPartner

  1007 @released

  1008 

  1009 SYMBIAN_SECURE_DBMS

  1010 

  1011 When SYMBIAN_SECURE_DBMS is defined, support for secure 

  1012 shared databases is enabled within DBMS.  

  1013 When not defined, all secure-shared-database-specific APIs 

  1014 take the form of dummy implementations which return KErrNone.

  1015 */

  1016 #define SYMBIAN_SECURE_DBMS

  1017 

  1018 /**

  1019 @publishedAll

  1020 @released

  1021 

  1022 SYMBIAN_ASSUME_SECURE_DATA

  1023 

  1024 When this macro is defined, all data files are assumed to be in their secure

  1025 locations, and all code which provided backward compatibility for the

  1026 insecure locations is removed. For example, ICL extended resource files

  1027 will not be loaded from System\Libs\Plugins, only from \Resource\ICL.

  1028 

  1029 This macro only makes sense if __SECURE_DATA__ is defined.

  1030 */

  1031 #define SYMBIAN_ASSUME_SECURE_DATA

  1032 

  1033 /**

  1034 @publishedAll

  1035 @deprecated

  1036 @since 8.0

  1037 

  1038 __KEYSTORE_API_V2__

  1039 

  1040 */

  1041 #define __KEYSTORE_API_V2__

  1042 

  1043 /**

  1044 @publishedAll

  1045 @released

  1046 

  1047 __SECURE_DATA__

  1048 

  1049 When __SECURE_DATA__ is defined, public read-only files are

  1050 assumed to be in their data-caged locations. The presence of

  1051 this #define does not imply that data-caging is enforced, and

  1052 does not imply that binaries have been relocated to sys\bin.

  1053 

  1054 This #define supports PREQ537 "Platform security - file system layout".

  1055 */

  1056 #define __SECURE_DATA__

  1057 

  1058 /**

  1059 @publishedAll

  1060 @released

  1061 

  1062 SYMBIAN_NETWORKING_PLATSEC

  1063 

  1064 If SYMBIAN_NETWORKING_PLATSEC is defined, additional platform security 

  1065 related functionality in enabled in the Comms-Infras and Networking 

  1066 subsystems (e.g. API policing).

  1067 */

  1068 #define SYMBIAN_NETWORKING_PLATSEC

  1069 

  1070 /**

  1071 @publishedAll

  1072 @released

  1073 

  1074 __CONDITIONS_SCHEDULES_VALID__

  1075 

  1076 If __CONDITIONS_SCHEDULES_VALID__ is defined then the Task Scheduler component 

  1077 supports creating persistent schedules based on a set of conditions and a 

  1078 timeout. The schedule is run when either all the conditions are met or the 

  1079 timeout is reached.

  1080 

  1081 This functionality is part of PREQ694 - PREQ 694 - Automatic sending of SMS on

  1082 network reconnection.

  1083 */

  1084 #define __CONDITIONS_SCHEDULES_VALID__

  1085 

  1086 /**

  1087 @internalComponent

  1088 

  1089 __LEAVE_EQUALS_THROW__

  1090 

  1091 If __LEAVE_EQUALS_THROW__ is defined, User::Leave() and TRAP() are 

  1092 implemented in terms of C++ exceptions where the compiler supports this.

  1093 If __LEAVE_EQUALS_THROW__ is not defined, the legacy Symbian exception 

  1094 mechanism is used instead.

  1095 

  1096 Support for C++ exceptions by the compiler is indicated by the 

  1097 internal macro __SUPPORT_CPP_EXCEPTIONS__ supplied by the tools.  

  1098 Where this macro is not present, __LEAVE_EQUALS_THROW__ is automatically 

  1099 undefined.

  1100 

  1101 This macro supports PREQ519 "Implement User::Leave() in terms of throw()".

  1102 */

  1103 #define __LEAVE_EQUALS_THROW__

  1104 

  1105 /**

  1106 @publishedAll

  1107 @released

  1108 

  1109 __BLUETOOTH_API_V2__

  1110 

  1111 If __BLUETOOTH_API_V2__ is defined assume that version 2 of the bluetooth

  1112 subsystem will be built.  This is binary compatible with version 1 for all

  1113 published-all APIs but is not source compatible.  Users of classes defined

  1114 in BTDevice.h and BTManClient.h may need to make source changes.

  1115 

  1116 The BTRegistry.dll is removed, users should link instead against BTManClient.lib.

  1117 The APIs provided by that DLL were classified as published-partner.

  1118 

  1119 @see CBTDevice

  1120 @see SGL.GT172.103 - Bluetooth Compatibility Specification

  1121 

  1122 If __BLUETOOTH_API_V2__ is not defined then version 1 of the bluetooth subsystem

  1123 will be built.

  1124 

  1125 */

  1126 #define __BLUETOOTH_API_V2__

  1127 

  1128 /**

  1129 @publishedAll

  1130 @released

  1131 

  1132 __BLUETOOTH_HCI_ALLOWS_AFH__

  1133 

  1134 If __BLUETOOTH_HCI_ALLOWS_AFH__ is defined the HCI interface will require the Adaptive Frequency Hopping CHCIBase pure virtual functions to be implemented in any derived class in Licensee produced host controller interface (HCI) code. 

  1135 If this is not defined no AFH commands may be sent to the host controller, and no AFH events will be received from the host controller.