File

Files
file	file-utils.h
	Utility functions for file access.

Functions
int	gncReadFile (const char *filename, char **data)
	Reads the contents of a file into a buffer for further processing.
gint64	gnc_getline (gchar **line, FILE *file)
	Read a line from the input file, up to and including the newline.

Detailed Description

Function Documentation

gnc_getline()

gint64 gnc_getline	(	gchar **	line,
		FILE *	file
	)

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!

Parameters

line	pointer to hold the buffer for the whole line (allocated by this function)
file	the file from which to read

Returns

The number of bytes read

Definition at line 133 of file file-utils.c.

{
    char str[BUFSIZ];
    gint64 len;
    GString *gs;
 
    g_return_val_if_fail(line, -1);
    *line = NULL;
    g_return_val_if_fail(file, -1);
 
    gs = g_string_new("");
 
    while (fgets(str, sizeof(str), file) != NULL)
    {
        g_string_append(gs, str);
 
        len = strlen(str);
        if (str[len-1] == '\n')
            break;
    }
 
    len = gs->len;
    *line = g_string_free (gs, FALSE);
    return len;
}

gncReadFile()

int gncReadFile	(	const char *	filename,
		char **	data
	)

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

Parameters

filename	the name of the html file to read
data	Pointer to a buffer to store the file's content.

Returns

The file size

Definition at line 61 of file file-utils.c.

{
    char *buf = NULL;
    char  *fullname;
    off_t   size = 0;
    int   fd;
 
    if (!filename || filename[0] == '\0') return 0;
 
    /* construct absolute path if we received a relative path */
    fullname = gnc_path_find_localized_html_file (filename);
 
    if (!fullname) return 0;
 
    /* Open file: */
    fd = g_open( fullname, O_RDONLY, 0 );
 
    g_free(fullname);
    fullname = NULL;
 
    if ( fd == -1 )
    {
        int norr = errno;
        PERR ("file %s: (%d) %s\n", filename, norr, strerror(norr));
        return 0;
    }
 
    /* Find size: */
    size = lseek( fd, 0, SEEK_END );
    lseek( fd, 0, SEEK_SET );
 
    if (size < 0)
    {
        int norr = errno;
        PERR ("file seek-to-end %s: (%d) %s\n", filename, norr, strerror(norr));
        return 0;
    }
    
    /* Allocate memory */
    buf = g_new(char, (size_t)size + 1);
 
    /* read in file */
    if ( read(fd, buf, (size_t)size) == -1 )
    {
        g_free(buf);
        buf = NULL;
    }
    else
    {
        buf[(size_t)size] = '\0';
    }
 
    close(fd);
    *data = buf;
 
    return size;
}