/** \file   archdep_user_state_path.c
 * \brief   Retrieve path to the user's state directory
 * \author  Bas Wassink <b.wassink@ziggo.nl>
 *
 * Get path to user's VICE state directory, this is where the vice files like
 * vice.log will be. `XDG_STATE_HOME` is meant for files that are supposed to
 * survive system reboots but aren't as persistent/import as files in
 * `XDG_DATA_HOME` (where the user's custom ROM files reside).
 *
 * This will be an excellent place for "session" files once we have implemented
 * those.
 *
 * OS support:
 *  - Linux
 *  - Windows (untested)
 *  - MacOS (untested)
 *  - BeOS/Haiku (untested)
 */

/*
 * This file is part of VICE, the Versatile Commodore Emulator.
 * See README for copyright notice.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 *  02111-1307  USA.
 *
 */

#include "vice.h"
#include "archdep_defs.h"

#include <stddef.h>
#ifdef WINDOWS_COMPILE
# include <windows.h>
# include <shlobj.h>
#endif

/* TODO: Haiku is a lot more POSIX-like than classic BeOS, so perhaps we should
 *       test for classic BeOS or Haiku and act accordingly.
 */
#if !defined(UNIX_COMPILE) && !defined(WINDOWS_COMPILE) \
    && !(defined(BEOS_COMPILE))
# include "archdep_boot_path.h"
#endif
#ifdef BEOS_COMPILE
# include "archdep_home_path.h"
#endif
#include "archdep_xdg.h"
#include "lib.h"
#include "util.h"

#include "archdep_user_state_path.h"


/** \brief  User's VICE state directory reference
 *
 * Allocated once in the first call to archdep_user_state_path(), should be
 * freed on emulator exit with archdep_user_state_path_free()
 */
static char *user_state_dir = NULL;


/** \brief  Get path to the user's VICE configuration directory
 *
 * On systems supporting home directories this will return a directory inside
 * the home directory, depending on OS:
 *
 * - Windows: $HOME\\AppData\\Roaming\\vice
 * - Unix: $HOME/.local/state/vice (rather: XDG_STATE_HOME)
 * - BeOS: $HOME/config/settings/vice ???
 *   (Haiku sets $XDG_CONFIG_HOME to '/boot/home/config/settings') ???
 *
 * On other systems the path to the executable is returned.
 *
 * Free memory used on emulator exit with archdep_user_state_path_free()
 *
 * \return  path to VICE state directory
 */
const char *archdep_user_state_path(void)
{
#ifdef WINDOWS_COMPILE
    TCHAR szPath[MAX_PATH];
#endif
    /* don't recalculate path if it's already known */
    if (user_state_dir != NULL) {
        return user_state_dir;
    }

#if defined(UNIX_COMPILE) || defined(HAIKU_COMPILE)
    char *xdg_state = archdep_xdg_state_home();
    user_state_dir = util_join_paths(xdg_state, "vice", NULL);
    lib_free(xdg_state);

#elif defined(WINDOWS_COMPILE)
    /*
     * Use WinAPI to get %APPDATA% directory, hopefully more reliable than
     * hardcoding 'AppData/Roaming'. We can't use SHGetKnownFolderPath() here
     * since SDL should be able to run on Windows XP and perhaps even lower.
     */
    if (SUCCEEDED(SHGetFolderPathA(NULL, CSIDL_APPDATA, NULL, 0, szPath))) {
        user_state_dir = util_join_paths(szPath, "vice", NULL);
    } else {
        user_state_dir = NULL;
    }
#else
    user_state_dir = lib_strdup(archdep_boot_path());
#endif
    return user_state_dir;
}


/** \brief  Free memory used by the user's config path
 */
void archdep_user_state_path_free(void)
{
    if (user_state_dir != NULL) {
        lib_free(user_state_dir);
        user_state_dir = NULL;
    }
}