Source

dark-hammer / include / core / core.h

/***********************************************************************************
 * Copyright (c) 2012, Sepehr Taghdisian
 * 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.
 *
 ***********************************************************************************/

#ifndef __CORE_H__
#define __CORE_H__

/**
 * @mainpage Core library API reference
 * Current version: 0.4.0
 */
 
 /**
 * @defgroup core
 * Core library essential headers and init/release\n
 * Include "core.h" and use core_init, core_release to initialize basic core functionality
 * Example: @code
 * #include "core/core.h"
 * int main()
 * {
 *      core_init(TRUE);
 *      // continue with application and engine initialization and update
 *      core_release();
 * }
 * @endcode
 */
 
 /* essential headers */
#include <stdio.h>

#include "types.h"
#include "mem-mgr.h"
#include "err.h"
#include "log.h"
#include "core-api.h"
#include "numeric.h"
#include "str.h"
#include "allocator.h"
#include "util.h"

#ifdef __cplusplus
extern "C"  {
#endif

/**
 * Initializes/releases main 'core' components\n
 * It initializes following core library sub-systems:
 * - memory
 * - logger
 * - error handling
 * - random
 * - json
 * - file-manager
 * - timer-manager
 * @ingroup core
 */
CORE_API result_t core_init(bool_t trace_mem);

/**
 * Release core components
 * @param report_leaks report memory leaks to the logger
 * @ingroup core
 */
CORE_API void core_release(bool_t report_leaks);

#ifdef __cplusplus
}
#endif

#endif /* __CORE_H__ */
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.