loader.h

/*
 * Copyright (c) 2007-2008, Brian Koropoff
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the Moonunit project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY BRIAN KOROPOFF ``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 BRIAN KOROPOFF 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 __MU_LOADER_H__
#define __MU_LOADER_H__

#include <moonunit/internal/boilerplate.h>
#include <moonunit/error.h>
#include <moonunit/plugin.h>
#include <moonunit/option.h>
#include <moonunit/test.h>
#include <sys/types.h>

C_BEGIN_DECLS

struct MuLibrary;

typedef void (*MuLogCallback)(struct MuLogEvent const* event, void* data);

typedef struct MuLoader
{
    struct MuPlugin* plugin;
    MuOption* options;
    // Determines if a library can be opened by this loader
    bool (*can_open) (struct MuLoader*, const char* path);
    // Opens a library and returns a handle
    struct MuLibrary* (*open) (struct MuLoader*, const char* path, MuError** err);
    // Returns a null-terminated list of unit tests
    struct MuTest** (*get_tests) (struct MuLoader*, struct MuLibrary* handle);
    // Frees a list of unit tests that had been returned by get_tests
    void (*free_tests) (struct MuLoader*, struct MuLibrary* handle, struct MuTest** list);
    // Closes a library
    void (*close) (struct MuLoader*, struct MuLibrary* handle);
    // Get name of a library
    const char* (*library_name) (struct MuLoader*, struct MuLibrary* handle);
    // Get the name of a test
    const char* (*test_name) (struct MuLoader*, struct MuTest*);
    // Get the suite of a test
    const char* (*test_suite) (struct MuLoader*, struct MuTest*);
    // Dispatch a single test
    struct MuTestResult* (*dispatch)(struct MuLoader*, struct MuTest*, MuLogCallback, void*, MuLogLevel);
    // Free the result of a unit test
    void (*free_result)(struct MuLoader*, struct MuTestResult*);
    /* Runs the constructor for a library, which does any needed *one-time* setup */
    void (*construct) (struct MuLoader*, struct MuLibrary* handle, MuError** err);
    /* Runs the destructor for a library, which does any needed *one-time* teardown */
    void (*destruct) (struct MuLoader*, struct MuLibrary* handle, MuError** err);
} MuLoader;

bool mu_loader_can_open(MuLoader* loader, const char* path);
struct MuLibrary* mu_loader_open(MuLoader* loader, const char* path, MuError** err);
void mu_loader_set_option(MuLoader* loader, const char *name, ...);
void mu_loader_set_option_string(MuLoader* loader, const char *name, const char *value);
MuType mu_loader_option_type(MuLoader* loader, const char *name);

C_END_DECLS

#endif