/*    Copyright 2009 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    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 Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects
 *    for all of the code used other than as permitted herein. If you modify
 *    file(s) with this exception, you may extend this exception to your
 *    version of the file(s), but you are not obligated to do so. If you do not
 *    wish to do so, delete this exception statement from your version. If you
 *    delete this exception statement from all source files in the program,
 *    then also delete it in the license file.
 */

/**
 * Tools for working with in-process stack traces.
 */

#pragma once

#include <iostream>

#include "mongo/util/log.h"

#if defined(_WIN32)
// We need to pick up a decl for CONTEXT. Forward declaring would be preferable, but it is
// unclear that we can do so.
#include "mongo/platform/windows_basic.h"
#endif

namespace mongo {

    // Print stack trace information to "os", default to the log stream.
    void printStackTrace(std::ostream &os=log().stream());

#if defined(_WIN32)
    // Print stack trace (using a specified stack context) to "os", default to the log stream.
    void printWindowsStackTrace(CONTEXT &context, std::ostream &os=log().stream());

    // Print error message from C runtime followed by stack trace
    int crtDebugCallback(int, char* originalMessage, int*);
#endif

}  // namespace mongo
