/* trace_invalid.h -- fixture to create an invalid trace
 * Copyright (C) 2014  Galois, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *   3. Neither Galois's name nor the names of other contributors may be used to
 *      endorse or promote products derived from this software without specific
 *      prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY GALOIS AND OTHER CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL GALOIS OR OTHER CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */

#ifndef PPAML_TRACER_TEST_TRACE_INVALID_H
#define PPAML_TRACER_TEST_TRACE_INVALID_H

#include "tmpdir.h"

#define HAVE_FIXTURE_trace_invalid HAVE_FIXTURE_tmpdir

#if HAVE_FIXTURE_trace_invalid
	void trace_invalid_make();

	/* Despite its name, this function does not actually clean anything.
	 * It's provided to make it easier to interface with Check. */
	void trace_invalid_clean();

	/* Returns the path to the trace.  If no trace is active, returns
	 * NULL. */
	const char *trace_invalid_path();

	// Registers the fixture.
	inline void trace_invalid_add_checked(TCase *const tc) {
		tcase_add_checked_fixture(
			tc,
			trace_invalid_make,
			trace_invalid_clean);
	}
#endif

#endif