include/share/grabbag/file.h

   1 /* grabbag - Convenience lib for various routines common to several tools
   2  * Copyright (C) 2002,2003,2004,2005,2006,2007,2008,2009  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 #include "share/compat.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 void grabbag__file_copy_metadata(const char *srcpath, const char *destpath);
  41 FLAC__off_t grabbag__file_get_filesize(const char *srcpath);
  42 const char *grabbag__file_get_basename(const char *srcpath);
  43
  44 /* read_only == false means "make file writable by user"
  45  * read_only == true means "make file read-only for everyone"
  46  */
  47 FLAC__bool grabbag__file_change_stats(const char *filename, FLAC__bool read_only);
  48
  49 /* returns true iff stat() succeeds for both files and they have the same device and inode. */
  50 /* on windows, uses GetFileInformationByHandle() to compare */
  51 FLAC__bool grabbag__file_are_same(const char *f1, const char *f2);
  52
  53 /* attempts to make writable before unlinking */
  54 FLAC__bool grabbag__file_remove_file(const char *filename);
  55
  56 /* these will forcibly set stdin/stdout to binary mode (for OSes that require it) */
  57 FILE *grabbag__file_get_binary_stdin(void);
  58 FILE *grabbag__file_get_binary_stdout(void);
  59
  60 #ifdef __cplusplus
  61 }
  62 #endif
  63
  64 #endif