lib-lib/file.h

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2006 Pierre Habouzit
  18  */
  19 /*
  20  * Copyright notice from original mutt:
  21  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  22  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
  23  *
  24  * This file is part of mutt-ng, see http://www.muttng.org/.
  25  * It's licensed under the GNU General Public License,
  26  * please see the file GPL in the top level source directory.
  27  */
  28
  29 /*
  30  * File manipulations + saner libgen functions
  31  */
  32
  33 #ifndef MUTT_LIB_LIB_FILE_H
  34 #define MUTT_LIB_LIB_FILE_H
  35
  36 /****************************************************************************/
  37 /* fd ops                                                                   */
  38 /****************************************************************************/
  39
  40 int safe_open(const char *, int);
  41 int safe_symlink(const char *, const char *);
  42 int safe_rename(const char *, const char *);
  43 void mutt_unlink(const char *);
  44
  45 /****************************************************************************/
  46 /* FILE* ops                                                                */
  47 /****************************************************************************/
  48
  49 FILE *safe_fopen(const char *, const char *);
  50 int mutt_rename_file(char *, char *);
  51
  52 static inline int m_fclose(FILE **f) {
  53     if (*f) {
  54         int res = fclose(*f);
  55         *f = NULL;
  56         return res;
  57     }
  58     return 0;
  59 }
  60
  61 char *mutt_read_line(char *, ssize_t *, FILE *, int *);
  62
  63 int mutt_copy_stream(FILE *, FILE *);
  64 int mutt_copy_bytes(FILE *, FILE *, ssize_t);
  65
  66 /****************************************************************************/
  67 /* path manipulations                                                       */
  68 /****************************************************************************/
  69
  70 const char *mutt_basename(const char *);
  71 ssize_t m_dirname(char *, ssize_t, const char *);
  72
  73 char *mutt_concat_path(char *, ssize_t, const char *, const char *);
  74
  75 void mutt_sanitize_filename(char *, short);
  76 ssize_t mutt_quote_filename(char *, ssize_t, const char *);
  77
  78 /* replace any %s with src, or appends " $src" */
  79 ssize_t m_file_fmt(char *dst, ssize_t n, const char *fmt, const char *src);
  80 ssize_t m_quotefile_fmt(char *, ssize_t, const char *, const char *);
  81
  82 int m_tempfd(char *dst, ssize_t n, const char *dir, const char *fmt);
  83 FILE *m_tempfile(char *dst, ssize_t n, const char *dir, const char *fmt);
  84
  85 /****************************************************************************/
  86 /* misc                                                                     */
  87 /****************************************************************************/
  88
  89 time_t m_decrease_mtime(const char *f, struct stat *st);
  90
  91 #endif /* MUTT_LIB_LIB_FILE_H */