filesystem.h

Go to the documentation of this file.

 
#ifndef FILESYSTEM_H
#define FILESYSTEM_H
 
#include <wireshark.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/*
 * Default profile name.
 */
#define DEFAULT_PROFILE      "Default"

WS_DLL_PUBLIC char *configuration_init(const char *arg0, const char* app_flavor_lower);

WS_DLL_PUBLIC const char *get_progfile_dir(void);

WS_DLL_PUBLIC char *get_executable_path(const char *filename);

WS_DLL_PUBLIC const char *get_plugins_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC const char *get_plugins_dir_with_version(const char* app_env_var_prefix);

WS_DLL_PUBLIC const char *get_plugins_pers_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC const char *get_plugins_pers_dir_with_version(const char* app_env_var_prefix);

WS_DLL_PUBLIC const char *get_extcap_dir(const char* app_env_var_prefix, const char* dir_extcap);

WS_DLL_PUBLIC const char *get_extcap_pers_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC bool running_in_build_directory(void);

WS_DLL_PUBLIC const char *get_datafile_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC char *get_datafile_path(const char *filename, const char* app_env_var_prefix);

WS_DLL_PUBLIC const char *get_doc_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC char *get_docfile_path(const char *filename, const char* app_env_var_prefix);

WS_DLL_PUBLIC char *doc_file_url(const char *filename, const char* app_env_var_prefix);

WS_DLL_PUBLIC const char *get_systemfile_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC void set_profile_name(const char *profilename);

WS_DLL_PUBLIC const char *get_profile_name(void);

WS_DLL_PUBLIC bool is_default_profile(void);

WS_DLL_PUBLIC bool has_global_profiles(const char* app_env_var_prefix);

WS_DLL_PUBLIC char *get_profiles_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC char *get_profile_dir(const char* app_env_var_prefix, const char *profilename, bool is_global);

WS_DLL_PUBLIC int create_profiles_dir(const char* app_env_var_prefix, char **pf_dir_path_return);

WS_DLL_PUBLIC char *get_global_profiles_dir(const char* app_env_var_prefix);

WS_DLL_PUBLIC void profile_store_persconffiles(bool store);

WS_DLL_PUBLIC void profile_register_persconffile(const char *filename);

WS_DLL_PUBLIC bool profile_exists(const char* app_env_var_prefix, const char *profilename, bool global);

WS_DLL_PUBLIC int create_persconffile_profile(const char* app_env_var_prefix, const char *profilename,
                       char **pf_dir_path_return);

WS_DLL_PUBLIC const GHashTable *allowed_profile_filenames(void);

WS_DLL_PUBLIC int delete_persconffile_profile(const char* app_env_var_prefix, const char *profilename,
                                              char **pf_dir_path_return);

WS_DLL_PUBLIC int rename_persconffile_profile(const char* app_env_var_prefix, const char *fromname, const char *toname,
                       char **pf_from_dir_path_return,
                       char **pf_to_dir_path_return);

WS_DLL_PUBLIC int copy_persconffile_profile(const char* app_env_var_prefix, const char *toname, const char *fromname,
                     bool from_global,
                     char **pf_filename_return,
                     char **pf_to_dir_path_return,
                     char **pf_from_dir_path_return);

WS_DLL_PUBLIC int create_persconffile_dir(const char* app_env_var_prefix, char **pf_dir_path_return);

WS_DLL_PUBLIC char *get_persconffile_path(const char *filename, bool from_profile, const char* app_env_var_prefix);

WS_DLL_PUBLIC void set_persconffile_dir(const char *p);

WS_DLL_PUBLIC const char *get_persdatafile_dir(void);

WS_DLL_PUBLIC void set_persdatafile_dir(const char *p);

WS_DLL_PUBLIC WS_RETNONNULL const char *get_current_working_dir(void);

WS_DLL_PUBLIC const char *file_open_error_message(int err, bool for_writing);

WS_DLL_PUBLIC const char *file_write_error_message(int err);

WS_DLL_PUBLIC const char *get_basename(const char *path);

WS_DLL_PUBLIC char *find_last_pathname_separator(const char *path);

WS_DLL_PUBLIC char *get_dirname(char *path);

WS_DLL_PUBLIC int test_for_directory(const char *path);

WS_DLL_PUBLIC int test_for_fifo(const char *path);

WS_DLL_PUBLIC bool test_for_regular_file(const char *path);

WS_DLL_PUBLIC bool file_exists(const char *fname);

WS_DLL_PUBLIC bool config_file_exists_with_entries(const char *fname, char comment_char);

WS_DLL_PUBLIC bool files_identical(const char *fname1, const char *fname2);

#define WS_FILENAME_RESERVED_PRINTABLE_CHARS "<>:\"/\\|?*"

#define WS_FILENAME_RESERVED_CHARS WS_FILENAME_RESERVED_PRINTABLE_CHARS \
    "\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a" \
    "\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14" \
    "\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f"

WS_DLL_PUBLIC char *filename_sanitize(const char *name, char replacement);

WS_DLL_PUBLIC unsigned files_identical_hash(const void* fname);

WS_DLL_PUBLIC bool file_needs_reopen(int fd, const char* filename);

WS_DLL_PUBLIC bool write_file_binary_mode(const char *filename,
    const void *content, size_t content_len);

WS_DLL_PUBLIC bool copy_file_binary_mode(const char *from_filename,
    const char *to_filename);
 

WS_DLL_PUBLIC char* data_file_url(const char *filename, const char* app_env_var_prefix);

WS_DLL_PUBLIC void free_progdirs(void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* FILESYSTEM_H */