mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-11-23 01:16:43 -06:00
83d14e1c1c
It is split into - /libgnucash (for the non-gui bits) - /gnucash (for the gui) - /common (misc source files used by both) - /bindings (currently only holds python bindings) This is the first step in restructuring the code. It will need much more fine tuning later on.
83 lines
3.3 KiB
C
83 lines
3.3 KiB
C
/********************************************************************\
|
|
* file-utils.h -- simple file utilities *
|
|
* Copyright (C) 1997 Robin D. Clark *
|
|
* Copyright (C) 1998 Linas Vepstas *
|
|
* Copyright (C) 1998 Rob Browning *
|
|
* Copyright (C) 2004 Derek Atkins <derek@ihtfp.com> *
|
|
* *
|
|
* 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., 675 Mass Ave, Cambridge, MA 02139, USA. *
|
|
* *
|
|
* Author: Rob Clark *
|
|
* Internet: rclark@cs.hmc.edu *
|
|
* Address: 609 8th Street *
|
|
* Huntington Beach, CA 92648-4632 *
|
|
\********************************************************************/
|
|
|
|
/** @addtogroup Utils Utility functions
|
|
@{ */
|
|
/** @addtogroup UtilFile File
|
|
* @{ */
|
|
/** @file file-utils.h
|
|
* @brief Utility functions for file access
|
|
* @author Copyright (C) 1997 Robin D. Clark
|
|
* @author Copyright (C) 1998 Linas Vepstas
|
|
* @author Copyright (C) 1998 Rob Browning
|
|
* @author Copyright (C) 2004 Derek Atkins <derek@ihtfp.com>
|
|
*
|
|
* These functions help you to locate files that can reside
|
|
* in multiple locations.
|
|
*/
|
|
|
|
#ifndef GNC_FILE_UTILS_H
|
|
#define GNC_FILE_UTILS_H
|
|
|
|
#include <stdio.h> /* for FILE* */
|
|
|
|
/** Reads the contents of a file into a buffer for further processing.
|
|
*
|
|
* If the filename is not an absolute filename, it will be searched
|
|
* for in the search path available to the program. This can be used
|
|
* to find for example help files,...
|
|
*
|
|
* Uses the global xxxPath as the path to search
|
|
*
|
|
* @param filename the name of the html file to read
|
|
*
|
|
* @param data Pointer to a buffer to store the file's content.
|
|
*
|
|
* @return The file size
|
|
*/
|
|
int gncReadFile (const char * filename, char ** data);
|
|
|
|
|
|
/** Read a line from the input file, up to and including the newline.
|
|
*
|
|
* The caller MUST g_free() the line returned from this call in all
|
|
* cases where it is non-NULL!
|
|
*
|
|
* @param line pointer to hold the buffer for the whole line (allocated by
|
|
* this function)
|
|
*
|
|
* @param file the file from which to read
|
|
*
|
|
* @return The number of bytes read
|
|
*/
|
|
gint64 gnc_getline (gchar **line, FILE *file);
|
|
|
|
#endif /* GNC_FILE_UTILS_H */
|
|
/** @} */
|
|
/** @} */
|
|
|