1/* grabbag - Convenience lib for various routines common to several tools
2 * Copyright (C) 2002,2003,2004,2005,2006,2007  Josh Coalson
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17 */
18
19/* Convenience routines for manipulating files */
20
21/* This .h cannot be included by itself; #include "share/grabbag.h" instead. */
22
23#ifndef GRABAG__FILE_H
24#define GRABAG__FILE_H
25
26/* needed because of off_t */
27#if HAVE_CONFIG_H
28#  include <config.h>
29#endif
30
31#include <sys/types.h> /* for off_t */
32#include <stdio.h> /* for FILE */
33#include "FLAC/ordinals.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39void grabbag__file_copy_metadata(const char *srcpath, const char *destpath);
40off_t grabbag__file_get_filesize(const char *srcpath);
41const char *grabbag__file_get_basename(const char *srcpath);
42
43/* read_only == false means "make file writable by user"
44 * read_only == true means "make file read-only for everyone"
45 */
46FLAC__bool grabbag__file_change_stats(const char *filename, FLAC__bool read_only);
47
48/* returns true iff stat() succeeds for both files and they have the same device and inode. */
49/* on windows, uses GetFileInformationByHandle() to compare */
50FLAC__bool grabbag__file_are_same(const char *f1, const char *f2);
51
52/* attempts to make writable before unlinking */
53FLAC__bool grabbag__file_remove_file(const char *filename);
54
55/* these will forcibly set stdin/stdout to binary mode (for OSes that require it) */
56FILE *grabbag__file_get_binary_stdin(void);
57FILE *grabbag__file_get_binary_stdout(void);
58
59#ifdef __cplusplus
60}
61#endif
62
63#endif
64