#ifndef COMMON__TEST_DATA_PATH__H
#define COMMON__TEST_DATA_PATH__H

/* $Id: test_data_path.h 698628 2025-06-16 18:49:42Z ivanov $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors: Andrei Gourianov, Denis Vakatov
 *
 * File Description:
 *   Defines location of test data folder at NCBI
 *
 */

/// @file test_data_path.h
/// Defines location of test data folder at NCBI.

#include <stdlib.h>
#include <string.h>
#include <corelib/ncbisys.hpp> // for strdup
#ifdef NCBI_OS_DARWIN
#  include <sys/stat.h>
#endif

/// Get the directory where test data is stored at NCBI.
/// The location is hard coded, but can be changed using
/// environment variables NCBI_TEST_DATA_PATH or NCBI_TEST_DATA.
///
/// @return
///   Pointer to internal zero-terminated string buffer, that contains 
///   a path to the test data. 
/// @note
///   The path can be terminated by a slash, or not. So, please use next
///   code to get an absolute path to the subfolder with a test data:
///       CFile::MakePath(NCBI_GetTestDataPath(), "some/test/path") ;
///   Also, you can use:
///       string path = NCBI_GetTestDataPath() + "/some/test/path");
///   Possible extra slash between path's parts will be ignored by OS.
///
static const char* NCBI_GetTestDataPath(void)
{
    static const char* s_NcbiTestDataPath = NULL;

    if (s_NcbiTestDataPath) {
        return s_NcbiTestDataPath;
    }
    s_NcbiTestDataPath = getenv("NCBI_TEST_DATA");
    if (s_NcbiTestDataPath) {
        return s_NcbiTestDataPath = NcbiSysChar_strdup(s_NcbiTestDataPath);
    }
    s_NcbiTestDataPath = getenv("NCBI_TEST_DATA_PATH");
    if (s_NcbiTestDataPath) {
        return s_NcbiTestDataPath = NcbiSysChar_strdup(s_NcbiTestDataPath);
    }

    s_NcbiTestDataPath =

//#ifdef NCBI_OS_DARWIN
//        "/netopt/toolkit_test_data/"
//#elif defined(NCBI_OS_MSWIN)

#if defined(NCBI_OS_MSWIN) || defined(NCBI_OS_CYGWIN)
        "\\\\snowman\\win-coremake\\Scripts\\test_data\\"
#else
        "/am/ncbiapdata/test_data/"
#endif
        ;
#ifdef NCBI_OS_DARWIN
    struct stat st;
    if (stat(s_NcbiTestDataPath, &st) != 0
        &&  stat("/Volumes/ncbiapdata/test_data/", &st) == 0) {
        s_NcbiTestDataPath = "/Volumes/ncbiapdata/test_data/";
    }
#endif
    return s_NcbiTestDataPath;
}

#endif /* COMMON__TEST_DATA_PATH__H */
