/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the qmake application of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QT_SYMBIAN_EPOCROOT_H
#define QT_SYMBIAN_EPOCROOT_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/qstring.h>

QT_BEGIN_NAMESPACE

/**
 * Determine the epoc root for the currently active SDK.
 *
 * The algorithm used is as follows:
 * 1. If environment variable EPOCROOT is set and points to an existent
 *    directory, this is returned.
 * 2. The location of devices.xml is specified by a registry key.  If this
 *    file exists, it is parsed.
 * 3. If the EPOCDEVICE environment variable is set and a corresponding
 *    entry is found in devices.xml, and its epocroot value points to an
 *    existent directory, it is returned.
 * 4. If a device element marked as default is found in devices.xml and its
 *    epocroot value points to an existent directory, this is returned.
 * 5. An empty string is returned.
 *
 * Any return value other than the empty string therefore is guaranteed to
 * point to an existent directory.
 */
QString qt_epocRoot();

QT_END_NAMESPACE

#endif // QT_SYMBIAN_EPOCROOT_H