tfCError.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/

 
#ifndef _WRAPS_C_TFCERROR_H_
#define _WRAPS_C_TFCERROR_H_
 
#include "tf_port_c.h"
 
// Handles

struct CAPI_EXPORT tfErrorHandle {
    void *tfObj;
};
 

// Error //
 

CAPI_FUNC(HRESULT) tfError_getErr(struct tfErrorHandle *handle, HRESULT *err);

CAPI_FUNC(HRESULT) tfError_getMsg(struct tfErrorHandle *handle, char **msg, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfError_getLineno(struct tfErrorHandle *handle, int *lineno);

CAPI_FUNC(HRESULT) tfError_getFname(struct tfErrorHandle *handle, char **fname, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfError_getFunc(struct tfErrorHandle *handle, char **func, unsigned int *numChars);
 

// Module functions //

CAPI_FUNC(HRESULT) tfErrSet(HRESULT code, const char* msg, int line, const char* file, const char* func);

CAPI_FUNC(bool) tfErrOccurred();

CAPI_FUNC(void) tfErrClear();

CAPI_FUNC(HRESULT) tfErrStr(struct tfErrorHandle *handle, char **str, unsigned int *numChars);

CAPI_FUNC(HRESULT) tfErrGetAll(struct tfErrorHandle ***handles, unsigned int *numErrors);

CAPI_FUNC(HRESULT) tfErrGetFirst(struct tfErrorHandle **handle);

CAPI_FUNC(void) tfErrClearFirst();

CAPI_FUNC(HRESULT) tfErrPopFirst(struct tfErrorHandle **handle);
 
 
#endif // _WRAPS_C_TFCERROR_H_