tools/shared/symbian/epocroot.h
branchRCL_3
changeset 8 3f74d0d4af4c
equal deleted inserted replaced
6:dee5afe5301f 8:3f74d0d4af4c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the qmake application of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef SYMBIAN_EPOCROOT_H
       
    43 #define SYMBIAN_EPOCROOT_H
       
    44 
       
    45 #include <QtCore/qstring.h>
       
    46 
       
    47 /**
       
    48  * Determine the epoc root for the currently active SDK.
       
    49  *
       
    50  * The algorithm used is as follows:
       
    51  * 1. If environment variable EPOCROOT is set and points to an existent
       
    52  *    directory, this is returned.
       
    53  * 2. The location of devices.xml is specified by a registry key.  If this
       
    54  *    file exists, it is parsed.
       
    55  * 3. If the EPOCDEVICE environment variable is set and a corresponding
       
    56  *    entry is found in devices.xml, and its epocroot value points to an
       
    57  *    existent directory, it is returned.
       
    58  * 4. If a device element marked as default is found in devices.xml and its
       
    59  *    epocroot value points to an existent directory, this is returned.
       
    60  * 5. An empty string is returned.
       
    61  *
       
    62  * Any return value other than the empty string therefore is guaranteed to
       
    63  * point to an existent directory.
       
    64  */
       
    65 QString epocRoot();
       
    66 
       
    67 #endif // EPOCROOT_H