buffer.c File Reference

Provides buffering of text strings. More...

#include "mdb.h"
#include "buffer.h"

Go to the source code of this file.

Classes
struct	buffer_struct

Macros
#define	DEBUG   0

Functions
void	create_buffer (char *name, int increment)
	Creates a new buffer with the specified name and slot increment.
void	add_to_buffer (char *name, char *string)
	Adds a string to the specified buffer.
void	clear_buffer (char *name)
	Clears all strings from the specified buffer.
void	fprintf_buffer (FILE *fp, char *format, char *name)
	Writes the contents of the specified buffer to a file using a specified format.
void	fputs_buffer (char *name, FILE *fp)
struct buffer_struct *	find_buffer (char *name)
int	buffer_exists (char *name)
	Checks if a buffer with the specified name exists.

Variables
struct buffer_struct *	buffers = NULL

Detailed Description

Provides buffering of text strings.

This file contains functions to create, manage, and manipulate buffers that store lines of text strings. Buffers can be dynamically created, added to, cleared, and printed to files.

Copyright

• (c) 2002 The University of Chicago, as Operator of Argonne National Laboratory.
• (c) 2002 The Regents of the University of California, as Operator of Los Alamos National Laboratory.

License

This file is distributed under the terms of the Software License Agreement found in the file LICENSE included with this distribution.

Author

C. Saunders, R. Soliday

Definition in file buffer.c.

Macro Definition Documentation

DEBUG

#define DEBUG   0

Definition at line 28 of file buffer.c.

Function Documentation

add_to_buffer()

void add_to_buffer	(	char *	name,
		char *	string )

Adds a string to the specified buffer.

If the buffer does not have enough slots to store the new string, it will be expanded by the buffer's slot increment value.

Parameters

name	The name of the buffer to add the string to.
string	The string to add to the buffer.

Definition at line 95 of file buffer.c.

                                             {
  struct buffer_struct *bptr;
 
  if (!(bptr = find_buffer(name)))
    bomb("unknown buffer referenced (add_to_buffer)", NULL);
 
  if (bptr->n_slots == 0)
    bptr->line = (char **)tmalloc(sizeof(*bptr->line) *
                                  (bptr->n_slots = bptr->n_slots_increment));
  else if (bptr->n_lines_stored == bptr->n_slots) {
    if (!(bptr->line = (char **)trealloc(bptr->line, sizeof(*bptr->line) *
                                                       (bptr->n_slots += bptr->n_slots_increment))))
      bomb("trealloc failure in add_to_buffer()", NULL);
  }
  cp_str(bptr->line + bptr->n_lines_stored++, string);
#if DEBUG
  printf("\"%s\" added to buffer %s--total of %d lines\n",
         string, buffers->name, buffers->n_lines_stored);
#endif
}

buffer_exists()

int buffer_exists

(

char *

name

)

Checks if a buffer with the specified name exists.

Parameters

name	The name of the buffer to check.

Returns

1 if the buffer exists, 0 otherwise.

Definition at line 183 of file buffer.c.

                              {
  if (find_buffer(name))
    return (1);
  return (0);
}

clear_buffer()

void clear_buffer

(

char *

name

)

Clears all strings from the specified buffer.

Frees all memory allocated for the strings in the buffer and resets the line count.

Parameters

name	The name of the buffer to clear.

Definition at line 123 of file buffer.c.

                              {
  int i;
  struct buffer_struct *bptr;
 
  if (!(bptr = find_buffer(name)))
    bomb("unknown buffer referenced (clear_buffer)", NULL);
  for (i = 0; i < bptr->n_lines_stored; i++)
    tfree(bptr->line[i]);
  bptr->n_lines_stored = 0;
}

create_buffer()

void create_buffer	(	char *	name,
		int	increment )

Creates a new buffer with the specified name and slot increment.

If a buffer with the given name already exists, the function will terminate the program with an error message.

Parameters

name	The name of the buffer to create.
increment	The number of slots to allocate when expanding the buffer. If zero, defaults to 1.

Definition at line 53 of file buffer.c.

                                              {
  struct buffer_struct *bptr;
 
  if (buffers == NULL) {
    buffers = tmalloc(sizeof(*buffers));
    buffers->next = NULL;
    buffers->n_slots = buffers->n_lines_stored = 0;
    cp_str(&(buffers->name), name);
    buffers->n_slots_increment = increment ? increment : 1;
#if DEBUG
    printf("buffer %s created--increment is %d\n",
           buffers->name, buffers->n_slots_increment);
#endif
  } else {
    if (find_buffer(name))
      bomb("duplicate buffer creation (create_buffer)", NULL);
    bptr = buffers;
    while (bptr->next)
      bptr = bptr->next;
    bptr = bptr->next = tmalloc(sizeof(*buffers));
    bptr->n_lines_stored = bptr->n_slots = 0;
    cp_str(&(bptr->name), name);
    bptr->n_slots_increment = increment ? increment : 1;
#if DEBUG
    printf("buffer %s created--increment is %d\n",
           bptr->name, bptr->n_slots_increment);
#endif
  }
#if DEBUG
  list_buffers();
#endif
}

find_buffer()

struct buffer_struct * find_buffer

(

char *

name

)

Definition at line 165 of file buffer.c.

                                              {
  struct buffer_struct *bptr;
 
  if ((bptr = buffers)) {
    do {
      if (strcmp(name, bptr->name) == 0)
        return (bptr);
    } while ((bptr = bptr->next));
  }
  return (NULL);
}

fprintf_buffer()

void fprintf_buffer	(	FILE *	fp,
		char *	format,
		char *	name )

Writes the contents of the specified buffer to a file using a specified format.

Each line in the buffer is printed to the file according to the provided format string.

Parameters

fp	The file pointer to write the buffer contents to.
format	The format string to use with fprintf for each line.
name	The name of the buffer to write.

Definition at line 143 of file buffer.c.

                                                        {
  struct buffer_struct *bptr;
  int i;
 
  if (!(bptr = find_buffer(name)))
    bomb("unknown buffer referenced (fprintf_buffer)", NULL);
  for (i = 0; i < bptr->n_lines_stored; i++) {
    fprintf(fp, format, bptr->line[i]);
  }
}

fputs_buffer()

void fputs_buffer	(	char *	name,
		FILE *	fp )

Definition at line 154 of file buffer.c.

                                        {
  struct buffer_struct *bptr;
  int i;
 
  if (!(bptr = find_buffer(name)))
    bomb("unknown buffer referenced (fputs_buffer)", NULL);
  for (i = 0; i < bptr->n_lines_stored; i++) {
    fputs(bptr->line[i], fp);
  }
}