more doxygen

[disorder] / lib / asprintf.c

/*
 * This file is part of DisOrder
 * Copyright (C) 2004, 2006 Richard Kettlewell
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */

#include <config.h>
#include "types.h"

#include <stdio.h>
#include <string.h>
#include <stdarg.h>
#include <stddef.h>
#include <errno.h>

#include "printf.h"
#include "sink.h"
#include "mem.h"
#include "vector.h"
#include "log.h"

/** @brief vasprintf() workalike without encoding errors
 *
 * This acts like vasprintf() except that it does not throw an error
 * if you use a string outside the current locale's encoding rules,
 * and it uses the memory allocation calls from @ref mem.h.
 */
int byte_vasprintf(char **ptrp,
		   const char *fmt,
		   va_list ap) {
  struct dynstr d;
  int n;

  dynstr_init(&d);
  if((n = byte_vsinkprintf(sink_dynstr(&d), fmt, ap)) >= 0) {
    dynstr_terminate(&d);
    *ptrp = d.vec;
  }
  return n;
}

/** @brief asprintf() workalike without encoding errors
 *
 * This acts like asprintf() except that it does not throw an error
 * if you use a string outside the current locale's encoding rules,
 * and it uses the memory allocation calls from @ref mem.h.
 */
int byte_asprintf(char **ptrp,
		  const char *fmt,
		  ...) {
  int n;
  va_list ap;

  va_start(ap, fmt);
  n = byte_vasprintf(ptrp, fmt, ap);
  va_end(ap);
  return n;
}

/** @brief asprintf() workalike without encoding errors
 *
 * This acts like asprintf() except that it does not throw an error if
 * you use a string outside the current locale's encoding rules; it
 * uses the memory allocation calls from @ref mem.h; and it terminates
 * the program on error.
 */
int byte_xasprintf(char **ptrp,
		   const char *fmt,
		   ...) {
  int n;
  va_list ap;

  va_start(ap, fmt);
  n = byte_xvasprintf(ptrp, fmt, ap);
  va_end(ap);
  return n;
}

/** @brief vasprintf() workalike without encoding errors
 *
 * This acts like vasprintf() except that it does not throw an error
 * if you use a string outside the current locale's encoding rules; it
 * uses the memory allocation calls from @ref mem.h; and it terminates
 * the program on error.
 */
int byte_xvasprintf(char **ptrp,
		    const char *fmt,
		    va_list ap) {
  int n;

  if((n = byte_vasprintf(ptrp, fmt, ap)) < 0)
    fatal(errno, "error calling byte_vasprintf");
  return n;
}

/*
Local Variables:
c-basic-offset:2
comment-column:40
End:
*/