StandardPaths.h

/*
 * Copyright 2017-2025 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <quentier/types/Account.h>
#include <quentier/utility/Linkage.h>

#define LIBQUENTIER_PERSISTENCE_STORAGE_PATH                                   \
    "LIBQUENTIER_PERSISTENCE_STORAGE_PATH"

namespace quentier::utility {

constexpr const char * gLibquentierPersistenceStoragePath =
    "LIBQUENTIER_PERSISTENCE_STORAGE_PATH";

[[nodiscard]] QString QUENTIER_EXPORT
    applicationPersistentStoragePath(bool * nonStandardLocation = nullptr);

[[nodiscard]] QString QUENTIER_EXPORT
    accountPersistentStoragePath(const Account & account);

[[nodiscard]] QString QUENTIER_EXPORT applicationTemporaryStoragePath();

[[nodiscard]] QString QUENTIER_EXPORT homePath();

[[nodiscard]] QString QUENTIER_EXPORT documentsPath();

} // namespace quentier::utility