wireshark/epan/filesystem.h
Guy Harris 6e622fd24e "gtk_entry_get_text()" returns a "const char *" - assign the result to
one.

"get_basename()" doesn't modify its argument, and its callers don't
modify the substring pointed to by the result, so make it take a "const
char *" as an argument and return a "const char *". 

"find_last_pathname_separator()" doesn't modify its argument, so make it
a "const char *" - but some of its callers pass a non-"const" "char *"
and modify the result, so don't make its return value a "const char *".
And, as none of its callers are outside "filesystem.c", make it static.

In "about_folders_page_new()", have separate variables for pathnames
returned as "const char *" (which are cached by the routine that returns
them, so you can't modify them - and can't free them, so get rid of the
commented-out "g_free()" calls for them) and pathnames returned as "char
*" (which are allocated anew for each call, and can be modified, but
have to be freed).

Clean up white space.

svn path=/trunk/; revision=12881
2004-12-31 00:26:36 +00:00

131 lines
3.8 KiB
C

/* filesystem.h
* Filesystem utility definitions
*
* $Id$
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
* Copyright 1998 Gerald Combs
*
* 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.
*/
#ifndef FILESYSTEM_H
#define FILESYSTEM_H
/*
* Given a pathname, return the last component.
*/
const char *get_basename(const char *);
/*
* Given a pathname, return a string containing everything but the
* last component. NOTE: this overwrites the pathname handed into
* it....
*/
char *get_dirname(char *);
/*
* Given a pathname, return:
*
* the errno, if an attempt to "stat()" the file fails;
*
* EISDIR, if the attempt succeeded and the file turned out
* to be a directory;
*
* 0, if the attempt succeeded and the file turned out not
* to be a directory.
*/
int test_for_directory(const char *);
/*
* Given a pathname, return:
*
* the errno, if an attempt to "stat()" the file fails;
*
* ESPIPE, if the attempt succeeded and the file turned out
* to be a FIFO;
*
* 0, if the attempt succeeded and the file turned out not
* to be a FIFO.
*/
int test_for_fifo(const char *);
/*
* Get the directory in which global configuration and data files are
* stored.
*/
extern const char *get_datafile_dir(void);
/*
* Construct the path name of a global configuration file, given the
* file name.
*/
extern char *get_datafile_path(const char *filename);
/*
* Get the directory in which files that, at least on UNIX, are
* system files (such as "/etc/ethers") are stored; on Windows,
* there's no "/etc" directory, so we get them from the Ethereal
* global configuration and data file directory.
*/
const char *get_systemfile_dir(void);
/*
* Create the directory that holds personal configuration files, if
* necessary. If we attempted to create it, and failed, return -1 and
* set "*pf_dir_path_return" to the pathname of the directory we failed
* to create (it's g_mallocated, so our caller should free it); otherwise,
* return 0.
*/
int create_persconffile_dir(char **pf_dir_path_return);
/*
* Construct the path name of a personal configuration file, given the
* file name.
*
* On Win32, if "for_writing" is FALSE, we check whether the file exists
* and, if not, construct a path name relative to the ".ethereal"
* subdirectory of the user's home directory, and check whether that
* exists; if it does, we return that, so that configuration files
* from earlier versions can be read.
*/
char *get_persconffile_path(const char *filename, gboolean for_writing);
/*
* Construct the path name of a file in $TMP/%TEMP% directory.
* Or "/tmp/<filename>" (C:\<filename>) if that fails.
*
* Return value is malloced so the caller should free it.
*/
extern char *get_tempfile_path(const char *filename);
/* Delete a file */
gboolean deletefile (const char *path);
/*
* Return an error message for UNIX-style errno indications on open or
* create operations.
*/
char *file_open_error_message(int err, gboolean for_writing);
/*
* Return an error message for UNIX-style errno indications on write
* operations.
*/
char *file_write_error_message(int err);
#endif /* FILESYSTEM_H */