mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-11-22 08:57:17 -06:00
222 lines
8.4 KiB
C++
222 lines
8.4 KiB
C++
/********************************************************************\
|
|
* 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 *
|
|
\********************************************************************/
|
|
|
|
/**
|
|
* @file gnc-filepath-utils.h
|
|
* @brief File path resolution utility functions
|
|
* @author Copyright (c) 1998-2004 Linas Vepstas <linas@linas.org>
|
|
* @author Copyright (c) 2000 Dave Peticolas
|
|
*/
|
|
|
|
#ifndef GNC_FILEPATH_UTILS_H
|
|
#define GNC_FILEPATH_UTILS_H
|
|
|
|
#include <glib.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** The gnc_resolve_file_path() routine is a utility that will accept
|
|
* a fragmentary filename as input, and resolve it into a fully
|
|
* qualified path in the file system, i.e. a path that begins with
|
|
* a leading slash. First, the current working directory is
|
|
* searched for the file. Next, the directory $HOME/.gnucash/data,
|
|
* and finally, a list of other (configurable) paths. If the file
|
|
* is not found, then the path $HOME/.gnucash/data is used. If
|
|
* $HOME is not defined, then the current working directory is
|
|
* used.
|
|
*/
|
|
gchar *gnc_resolve_file_path (const gchar *filefrag);
|
|
|
|
/** Given a prefix and a path return the relative portion of the path.
|
|
* @param prefix The prefix that might be the first part of the path
|
|
* @param path The path from which the prefix might be removed
|
|
* @return a char* that must be g_freed containing the path without
|
|
* the prefix if path begins with prefix, otherwise a copy of path.
|
|
*/
|
|
gchar *gnc_file_path_relative_part (const gchar *prefix, const gchar *path);
|
|
|
|
/** Given a prefix and a relative path, return the absolute path.
|
|
* @param prefix The prefix that is the head of the path
|
|
* @param relative The path to add to the prefix to form an absolute path
|
|
* @return a char* that must be g_freed containing the absolute path.
|
|
*
|
|
* If prefix is null, then the gnc_userdata_home is used as the prefix.
|
|
*/
|
|
gchar *gnc_file_path_absolute (const gchar *prefix, const gchar *relative);
|
|
|
|
/** @brief Find an absolute path to a localized version of a given
|
|
* relative path to a html or html related file.
|
|
* If no localized version exists, an absolute path to the file
|
|
* is searched for. If that file doesn't exist either, returns NULL.
|
|
*
|
|
* @warning file_name should be a simple path fragment. It shouldn't
|
|
* contain xml:// or http:// or <whatever>:// other protocol specifiers.
|
|
*
|
|
* If passed a string which g_path_is_absolute declares an absolute
|
|
* path, return the argument.
|
|
*
|
|
* Otherwise, assume that file_name is a well-formed relative path and
|
|
* try to find a file with its path relative to
|
|
* \li a localized subdirectory in the html directory
|
|
* of the user's configuration directory
|
|
* (e.g. $HOME/.gnucash/html/de_DE, $HOME/.gnucash/html/en,...)
|
|
* \li a localized subdirectory in the gnucash documentation directory
|
|
* (e.g. /usr/share/doc/gnucash/C,...)
|
|
* \li the html directory of the user's configuration directory
|
|
* (e.g. $HOME/.gnucash/html)
|
|
* \li the gnucash documentation directory
|
|
* (e.g. /usr/share/doc/gnucash/)
|
|
*
|
|
* The paths are searched for in that order. If a matching file is
|
|
* found, return the absolute path to it.
|
|
|
|
* If one isn't found, return NULL.
|
|
*
|
|
* @param file_name The file path to resolve
|
|
*
|
|
* @return An absolute file path or NULL if no file is found.
|
|
*/
|
|
gchar *gnc_path_find_localized_html_file (const gchar *file_name);
|
|
|
|
/** @brief Initializes the gnucash user data directory.
|
|
* This function should be called very early at startup (before any
|
|
* other of the user data directory related function gets called).
|
|
*
|
|
* @note If the necessary directories did get created this
|
|
* function will also try to copy files from $HOME/.gnucash
|
|
* to there if that old location exists.
|
|
*
|
|
* @return a migration message when files got copied from the old location, NULL otherwise
|
|
*/
|
|
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);
|
|
|
|
/** Given a pixmap/pixbuf file name, find the file in the pixmap
|
|
* directory associated with this application. This routine will
|
|
* display an error message if it can't find the file.
|
|
*
|
|
* @param name The name of the file to be found.
|
|
*
|
|
* @return the full path name of the file, or NULL of the file can't
|
|
* be found.
|
|
*
|
|
* @note It is the caller's responsibility to free the returned string.
|
|
*/
|
|
gchar *gnc_filepath_locate_pixmap (const gchar *name);
|
|
|
|
|
|
/** Given a file name, find the file in the directories associated
|
|
* with this application. This routine will display an error message
|
|
* if it can't find the file.
|
|
*
|
|
* @param name The name of the file to be found.
|
|
*
|
|
* @return the full path name of the file, or NULL of the file can't
|
|
* be found.
|
|
*
|
|
* @note It is the caller's responsibility to free the returned string.
|
|
*/
|
|
gchar *gnc_filepath_locate_data_file (const gchar *name);
|
|
|
|
|
|
/** Given a ui file name, find the file in the ui directory associated
|
|
* with this application. This routine will display an error message
|
|
* if it can't find the file.
|
|
*
|
|
* @param name The name of the file to be found.
|
|
*
|
|
* @return the full path name of the file, or NULL of the file can't
|
|
* be found.
|
|
*
|
|
* @note It is the caller's responsibility to free the returned string.
|
|
*/
|
|
gchar *gnc_filepath_locate_ui_file (const gchar *name);
|
|
|
|
|
|
/** Given a documentation file name, find the file in the doc directory
|
|
* associated with this application. This routine will display an error
|
|
* message if it can't find the file.
|
|
*
|
|
* @param name The name of the file to be found.
|
|
*
|
|
* @return the full path name of the file, or NULL of the file can't
|
|
* be found.
|
|
*
|
|
* @note It is the caller's responsibility to free the returned string.
|
|
*/
|
|
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>
|
|
|
|
/** Open std::ofstream from a UTF-8 encoded path. This is harder than
|
|
* it should because std::ofstream's constructor needs to be tricked
|
|
* into taking a wchar_t filename: Simply converting path to a
|
|
* wchar_t* with g_utf8_to_utf16() wouldn't compile. The workaround
|
|
* came from https://github.com/boostorg/filesystem/issues/181. As
|
|
* noted there passing the boost path directly to
|
|
* boost::filesystem::fstream doesn't work either.
|
|
* @param path UTF-8 path to the file
|
|
* @return a std::ofstream on the stack.
|
|
*/
|
|
std::ofstream gnc_open_filestream(const char *path);
|
|
|
|
#include <vector>
|
|
|
|
struct EnvPaths
|
|
{
|
|
const gchar *env_name;
|
|
const gchar *env_path;
|
|
gboolean modifiable;
|
|
};
|
|
|
|
|
|
/** Returns a vector of the environment variables used by GnuCash.
|
|
*
|
|
* @return a vector of EnvPaths structs, describing the environment
|
|
* variables used by GnuCash.
|
|
*/
|
|
std::vector<EnvPaths> gnc_list_all_paths ();
|
|
|
|
#endif
|
|
|
|
#endif /* GNC_FILEPATH_UTILS_H */
|