1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
|
/*
* tardy - a tar post-processor
* Copyright (C) 1994, 1995, 1998, 1999, 2004 Peter Miller;
* All rights reserved.
*
* 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, USA.
*
* MANIFEST: interface definition for common/mprintf.c
*/
#ifndef COMMON_MPRINTF_H
#define COMMON_MPRINTF_H
#include <ac/stdarg.h>
#include <main.h>
/**
* The mprintf function is used to format a string into memory.
*
* \param fmt
* The mesaage format to use. See printf(3) for documentation of
* the format and its arguments.
* \returns
* Pointer to NUL terminated string in synamic memory.
* <b>Do not</b> use mem_free when you are done with it.
*/
char *mprintf(const char *fmt, ...) ATTR_PRINTF(1, 2);
/**
* The mprintf_errok function is used to format a string into memory.
* Safe to call from error reporting functions.
*
* \param fmt
* The mesaage format to use. See printf(3) for documentation of
* the format and its arguments.
* \returns
* Pointer to NUL terminated string in synamic memory.
* <b>Do not</b> use mem_free when you are done with it.
*/
char *mprintf_errok(const char *fmt, ...) ATTR_PRINTF(1, 2);
/**
* The mprintf function is used to format a string into memory.
*
* \param fmt
* The mesaage format to use. See vprintf(3) for documentation of
* the format and its arguments.
* \param arglist
* The arguments to be used for the format.
* \returns
* Pointer to NUL terminated string in synamic memory.
* <b>Do not</b> use mem_free when you are done with it.
*/
char *vmprintf(const char *fmt, va_list arglist);
/**
* The mprintf function is used to format a string into memory.
* Safe to call from error reporting functions.
*
* \param fmt
* The mesaage format to use. See vprintf(3) for documentation of
* the format and its arguments.
* \param arglist
* The arguments to be used for the format.
* \returns
* Pointer to NUL terminated string in synamic memory.
* <b>Do not</b> use mem_free when you are done with it.
*/
char *vmprintf_errok(const char *fmt, va_list arglist);
/**
* The vmprintf_str function is just like the vmprintf function, except
* that it constructs a string_ty value from it.
*/
struct string_ty *vmprintf_str(const char *fmt, va_list);
#endif /* COMMON_MPRINTF_H */
|