gnc-filepath-utils.h

Go to the documentation of this file.

/********************************************************************\
 * gnc-filepath-utils.h -- file path resolution utilities           *
 *                                                                  *
 * 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, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
\********************************************************************/

#ifndef GNC_FILEPATH_UTILS_H
#define GNC_FILEPATH_UTILS_H

#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

gchar *gnc_resolve_file_path (const gchar *filefrag);

gchar *gnc_file_path_relative_part (const gchar *prefix, const gchar *path);

gchar *gnc_file_path_absolute (const gchar *prefix, const gchar *relative);

gchar *gnc_path_find_localized_html_file (const gchar *file_name);

char * gnc_filepath_init (void);

const gchar *gnc_userdata_dir (void);
gchar *gnc_build_userdata_path (const gchar *filename);
gchar *gnc_build_userconfig_path (const gchar *filename);
gchar *gnc_build_book_path (const gchar *filename);
gchar *gnc_build_translog_path (const gchar *filename);
gchar *gnc_build_data_path (const gchar *filename);
gchar *gnc_build_scm_path (const gchar *filename);
gchar *gnc_build_report_path (const gchar *filename);
gchar *gnc_build_reports_path (const gchar *dirname);
gchar *gnc_build_stdreports_path (const gchar *filename);

const gchar *gnc_userconfig_dir (void);

gchar *gnc_filepath_locate_pixmap (const gchar *name);


gchar *gnc_filepath_locate_data_file (const gchar *name);


gchar *gnc_filepath_locate_ui_file (const gchar *name);


gchar *gnc_filepath_locate_doc_file (const gchar *name);

gboolean gnc_filename_is_backup (const char *filename);

gboolean gnc_filename_is_datafile (const char *filename);

#ifdef __cplusplus
} //extern "C"

#include <fstream>

std::ofstream gnc_open_filestream(const char *path);

#include <vector>

struct EnvPaths
{
    const gchar *env_name;
    const gchar *env_path;
    gboolean modifiable;
};


std::vector<EnvPaths> gnc_list_all_paths ();

#endif

#endif /* GNC_FILEPATH_UTILS_H */