/*
 * Copyright (c) 1996 Barton P. Miller
 * 
 * We provide the Paradyn Parallel Performance Tools (below
 * described as Paradyn") on an AS IS basis, and do not warrant its
 * validity or performance.  We reserve the right to update, modify,
 * or discontinue this software at any time.  We shall have no
 * obligation to supply such updates or modifications or any other
 * form of support to you.
 * 
 * This license is for research uses.  For such uses, there is no
 * charge. We define "research use" to mean you may freely use it
 * inside your organization for whatever purposes you see fit. But you
 * may not re-distribute Paradyn or parts of Paradyn, in any form
 * source or binary (including derivatives), electronic or otherwise,
 * to any other organization or entity without our permission.
 * 
 * (for other uses, please contact us at paradyn@cs.wisc.edu)
 * 
 * All warranties, including without limitation, any warranty of
 * merchantability or fitness for a particular purpose, are hereby
 * excluded.
 * 
 * By your use of Paradyn, you understand and agree that we (or any
 * other person or entity with proprietary rights in Paradyn) are
 * under no obligation to provide either maintenance services,
 * update services, notices of latent defects, or correction of
 * defects for Paradyn.
 * 
 * Even if advised of the possibility of such damages, under no
 * circumstances shall we (or any other person or entity with
 * proprietary rights in the software licensed hereunder) be liable
 * to you or any third party for direct, indirect, or consequential
 * damages of any character regardless of type of action, including,
 * without limitation, loss of profits, loss of use, loss of good
 * will, or computer failure or malfunction.  You agree to indemnify
 * us (and any other person or entity with proprietary rights in the
 * software licensed hereunder) for any and all liability it may
 * incur to third parties resulting from your use of Paradyn.
 */

#ifndef _BPatch_h_
#define _BPatch_h_

#include "BPatch_Vector.h"
#include "BPatch_thread.h"

class BPatch_typeCollection;
class BPatch_type;

typedef enum BPatchErrorLevel {
    BPatchFatal, BPatchSerious, BPatchWarning, BPatchInfo
};

typedef void (*BPatchErrorCallback)(BPatchErrorLevel severity,
				    int number,
				    const char **params);

class BPatch {
    friend bool pollForStatusChange();

    BPatch_Vector<BPatch_thread*> threadVec;
    BPatchErrorCallback		errorHandler;
    bool			typeCheckOn;

    BPatch_thread *pidToThread(int pid);
public:
    static BPatch		*bpatch;

    BPatch_typeCollection	*stdTypes;
    BPatch_type			*type_Error;
    BPatch_type			*type_Untyped;

    BPatch();
    ~BPatch();

    // XXX The following function is a temporary hack until we make
    // the error reporing work the way we eventually want it to.
    void reportError(BPatchErrorLevel severity, int number, const char *str);

    static const char *getEnglishErrorString(int number);
    static void formatErrorString(char *dst, int size,
				  const char *fmt, const char **params);
    BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
    BPatch_Vector<BPatch_thread*> *getThreads();

    void setTypeChecking(bool x) { typeCheckOn = x; }

    // The following are only to be called by the library:
    bool isTypeChecked() { return typeCheckOn; }

    void registerThread(BPatch_thread *thread) { threadVec.push_back(thread); }
};

extern bool pollForStatusChange();

#endif /* _BPatch_h_ */