/*************************************************************************
 *
 * $Id: stacktrace.h,v 1.1 2004-10-08 20:30:25 schoenebeck Exp $
 *
 * Copyright (c) 1998 by Bjorn Reese <breese@mail1.stofanet.dk>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 * MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE AUTHORS AND
 * CONTRIBUTORS ACCEPT NO RESPONSIBILITY IN ANY CONCEIVABLE MANNER.
 *
 ************************************************************************
 *
 * Purpose:
 *  To generate a stacktrace of a program.
 *
 * Description:
 *  If a debugger is located on the machine we will try this first,
 *  as it usually give better information than built-in methods.
 *  The debugger needs the name of the program to be able to attach
 *  to it, so this must be passed to StackTraceInit(). The second
 *  argument is a filedescriptor that StackTrace() writes to. If this
 *  argument is -1 then standard output will be used.
 *
 * Compilation:
 *  Some platforms have a built-in method to generate stacktraces, but
 *  they are usually located in some non-standard library. The following
 *  are supported:
 *
 *   IRIX    Compile with -DUSE_BUILTIN and -lexc
 *   HP/UX   Compile with -DUSE_BUILTIN and -lcl
 *   GCC     Compile with -DUSE_BUILTIN
 *
 ************************************************************************/

#ifndef H_DEBUG_STACKTRACE
#define H_DEBUG_STACKTRACE

#if defined(__cplusplus)
extern "C" {
#endif // __cplusplus

void StackTrace(void);
void StackTraceInit(const char *progname, int handle);

#if defined(__cplusplus)
}
#endif // __cplusplus

#endif /* H_DEBUG_STACKTRACE */