/simpletypesystem/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/simpletypesystem/trunk
11 by Gustav Hartvigsson
* Finnished up a the inheritance documentation.
1
/**
91 by Gustav Hartvigsson
* Moved Version Number to config.h.in
2
 * @file
11 by Gustav Hartvigsson
* Finnished up a the inheritance documentation.
3
 * @mainpage SSTS -- The (Super) Simple Type System
4
 * @author Gustav Hartvigsson
5
 * @version 0.0.1-bzr (dev)
6
 * 
7
 * @section About
8
 * The (Super) Simple Type System is -- yet -- only an experiment. The base
91 by Gustav Hartvigsson
* Moved Version Number to config.h.in
9
 * for (almost) all objects in the system are derived from @ref SObject .
10
 * 
11 by Gustav Hartvigsson
* Finnished up a the inheritance documentation.
11
 * 
12
 * 
13
 */
14
126.1.1 by Gustav Hartvigsson
* Using
15
#pragma once
3 by Gustav Hartvigsson
Fixed a few things...
16
29 by Gustav Hartvigsson
* Switched to CMake to future proof the project a lil' bit.
17
#include "config.h"
146 by Gustav Hartvigsson
* Reorderd includes in SimpleTypeSystem.h
18
#include "defs.h"
29 by Gustav Hartvigsson
* Switched to CMake to future proof the project a lil' bit.
19
146 by Gustav Hartvigsson
* Reorderd includes in SimpleTypeSystem.h
20
#include "BaseN.h"
60 by Gustav Hartvigsson
* Added preliminary Matrix type and functions.
21
#include "baseobject.h"
79 by Gustav Hartvigsson
* Clean up of SMap's for each code.
22
#include "Box.h"
62 by Gustav Hartvigsson
* General documentation clean up.
23
#include "Callback.h"
60 by Gustav Hartvigsson
* Added preliminary Matrix type and functions.
24
#include "DynamicArray.h"
3 by Gustav Hartvigsson
Fixed a few things...
25
#include "Error.h"
26
#include "Func.h"
146 by Gustav Hartvigsson
* Reorderd includes in SimpleTypeSystem.h
27
#include "GlobalNotify.h"
5.2.7 by Gustav Hartvigsson
* Switched licence to a more permisive one.
28
#include "hash.h"
11 by Gustav Hartvigsson
* Finnished up a the inheritance documentation.
29
#include "Interface.h"
146 by Gustav Hartvigsson
* Reorderd includes in SimpleTypeSystem.h
30
#include "LinkedList.h"
11 by Gustav Hartvigsson
* Finnished up a the inheritance documentation.
31
#include "MainLoop.h"
5.2.7 by Gustav Hartvigsson
* Switched licence to a more permisive one.
32
#include "Map.h"
60 by Gustav Hartvigsson
* Added preliminary Matrix type and functions.
33
#include "Matrix.h"
5.2.8 by Gustav Hartvigsson
* Copied over LinkedList and DynamicArray from c_sdl_js
34
#include "utils.h"
146 by Gustav Hartvigsson
* Reorderd includes in SimpleTypeSystem.h
35
36
5.2.7 by Gustav Hartvigsson
* Switched licence to a more permisive one.
37
79 by Gustav Hartvigsson
* Clean up of SMap's for each code.
38
110 by Gustav Hartvigsson
* added S_ prifix to my macros. I should not be a scrub.
39
S_BEGIN_DECLS
3 by Gustav Hartvigsson
Fixed a few things...
40
118 by Gustav Hartvigsson
* Added embedded copyright information in the library.
41
S_UNUSED
42
static char *
43
__LIBSSTS__LICENSE__[] = {
152 by Gustav Hartvigsson
* Made SRandom compile
44
"Copyright (c) 2013-2017 Gustav Hartvigsson\n"
118 by Gustav Hartvigsson
* Added embedded copyright information in the library.
45
"\n"
46
"Permission is hereby granted, free of charge, to any person obtaining a copy "
47
"of this software and associated documentation files (the \"Software\"), to deal "
48
"in the Software without restriction, including without limitation the rights "
49
"to use, copy, modify, merge, publish, distribute, sublicense, and/or sell "
50
"copies of the Software, and to permit persons to whom the Software i "
51
"furnished to do so, subject to the following conditions: \n"
52
"\n"
53
"The above copyright notice and this permission notice shall be included in "
54
"all copies or substantial portions of the Software. \n"
55
"\n"
146 by Gustav Hartvigsson
* Reorderd includes in SimpleTypeSystem.h
56
"THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR "
57
"IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  "
118 by Gustav Hartvigsson
* Added embedded copyright information in the library.
58
"FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE "
59
"AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER "
60
"LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, "
61
"OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN "
62
"THE SOFTWARE.\n",
63
0x0,
64
0x0
65
};
66
67
S_UNUSED
68
static char *
69
__LIBSSTS__AUTHOR__[] = {
70
"(2013-2016) Gustav Hartvigsson <+GustavHartvigsson><gustav.hartvigsson@gmail.com>",
71
0x0,
72
0x0
73
};
74
75
S_UNUSED
76
static char * __LIBSSTS__INFO__[] = {
77
"Library Name: libssts",
78
"Library Full Name: Super Simple Type System",
79
"libssts is a simpel, \"object\" system in the style of GObject. The library "
80
"has main loop functionallity and some data structures like DynamicArray and "
81
"LinkedList. It is very versetile and what not. Have fun!",
82
0x0,
83
0x0
84
};
85
5.1.1 by Gustav Hartvigsson
* Started work on making the code more prasable by DoxyGen.
86
/**
87
 * Returns a string representing the current version.
88
 */
119 by Gustav Hartvigsson
* added S_EXPERTED to public functions.
89
S_EXPORTED
61 by Gustav Hartvigsson
* Made the code more easy to read.
90
char *
91
s_get_version_string ();
5.1.1 by Gustav Hartvigsson
* Started work on making the code more prasable by DoxyGen.
92
93
/**
94
 * Returns the Major version as on int.
95
 */
119 by Gustav Hartvigsson
* added S_EXPERTED to public functions.
96
S_EXPORTED
61 by Gustav Hartvigsson
* Made the code more easy to read.
97
int
98
s_get_version_major ();
5.1.1 by Gustav Hartvigsson
* Started work on making the code more prasable by DoxyGen.
99
100
/**
101
 * Returns the Minor version as on int.
102
 */
119 by Gustav Hartvigsson
* added S_EXPERTED to public functions.
103
S_EXPORTED
61 by Gustav Hartvigsson
* Made the code more easy to read.
104
int
105
s_get_version_minor ();
5.1.1 by Gustav Hartvigsson
* Started work on making the code more prasable by DoxyGen.
106
107
/**
108
 * Returns the Patch version as on int.
109
 */
119 by Gustav Hartvigsson
* added S_EXPERTED to public functions.
110
S_EXPORTED
61 by Gustav Hartvigsson
* Made the code more easy to read.
111
int
112
s_get_version_patch ();
3 by Gustav Hartvigsson
Fixed a few things...
113
146 by Gustav Hartvigsson
* Reorderd includes in SimpleTypeSystem.h
114
/**
115
 * This tears down the resourses that have been allocated by the library.
116
 *
117
 * @note This calls s_global_notify_teardown() and s_mm_cleanup().
118
 */
119
S_EXPORTED
120
void
121
s_teardown ();
122
3 by Gustav Hartvigsson
Fixed a few things...
123
110 by Gustav Hartvigsson
* added S_ prifix to my macros. I should not be a scrub.
124
S_END_DECLS