1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* The MIT License
*
* Copyright (C) 2010-2017 Alexander Saprykin <saprykin.spb@gmail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* 'Software'), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/**
* @file pmain.h
* @brief Library initialization
* @author Alexander Saprykin
*
* Before using the library you must to initialize it properly. Use
* p_libsys_init() to initialize the library. Please note that you need to call
* it only once, not in every thread. This call is not MT-safe (because it also
* initializes the threading subsystem itself), so it is best to place it in the
* program's main thread, when the program starts.
*
* The only difference between p_libsys_init() and p_libsys_init_full() is that
* the latter one allows to setup memory management routines before doing any
* internal library call. This way you can ensure to use provided memory
* management everywhere (even for library initialization).
*
* When you do not need the library anymore release used resourses with the
* p_libsys_shutdown() routine. You should only call it once, too. This call is
* not MT-safe (because it also deinitializes the threading subsystem itself),
* so it is best to place it in the program's main thread, when the program
* finishes.
*
* It is not recommended to call the initialization and deinitialization
* routines on Windows in the DllMain() call because it may require libraries
* other than kernel32.dll.
*/
/**
* @mainpage
* Basic
* - @link
* pmain.h Library initialization
* @endlink
* - @link
* ptypes.h Data types
* @endlink
* - @link
* pmacroscpu.h CPU detection macros
* @endlink
* - @link
* pmacrosos.h OS detection macros
* @endlink
* - @link
* pmacroscompiler.h Compiler detection macros
* @endlink
* - @link
* pmacros.h Miscellaneous macros
* @endlink
* - @link
* pstring.h Strings
* @endlink
*
* System
* - @link
* pmem.h Memory management
* @endlink
* - @link
* pprocess.h Process
* @endlink
* - @link
* plibraryloader.h Shared library loader
* @endlink
* - @link
* ptimeprofiler.h Time profiler
* @endlink
* - @link
* perror.h Errors
* @endlink
*
* Data structures
* - @link
* plist.h Singly linked list
* @endlink
* - @link
* phashtable.h Hash table
* @endlink
* - @link
* pcryptohash.h Cryptographic hash
* @endlink
* - @link
* ptree.h Binary search tree
* @endlink
*
* Multithreading
* - @link
* puthread.h Thread
* @endlink
* - @link
* pmutex.h Mutex
* @endlink
* - @link
* pcondvariable.h Condition variable
* @endlink
* - @link
* prwlock.h Read-write lock
* @endlink
* - @link
* pspinlock.h Spinlock
* @endlink
* - @link
* patomic.h Atomic operations
* @endlink
*
* Interprocess communication
* - @link
* psemaphore.h Semaphore
* @endlink
* - @link
* pshm.h Shared memory
* @endlink
* - @link
* pshmbuffer.h Shared memory buffer
* @endlink
*
* Networking
* - @link
* psocketaddress.h Socket address
* @endlink
* - @link
* psocket.h Socket
* @endlink
*
* File and directories
* - @link
* pfile.h Files
* @endlink
* - @link
* pdir.h Directories
* @endlink
* - @link
* pinifile.h INI file parser
* @endlink
*
* Stack
* - @link
* pstdarg.h Variable number of arguments
* @endlink
*/
#if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
# error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
#endif
#ifndef PLIBSYS_HEADER_PMAIN_H
#define PLIBSYS_HEADER_PMAIN_H
#include <pmacros.h>
#include <pmem.h>
P_BEGIN_DECLS
/**
* @brief Initializes library resources.
* @since 0.0.1
*/
P_LIB_API void p_libsys_init (void);
/**
* @brief Initializes library resources along with the memory table.
* @param vtable Memory management table.
* @since 0.0.1
*/
P_LIB_API void p_libsys_init_full (const PMemVTable *vtable);
/**
* @brief Frees library resources. You should stop using any of the library
* routines after calling this one.
* @since 0.0.1
*/
P_LIB_API void p_libsys_shutdown (void);
/**
* @brief Gets the library version against which it was compiled at run-time.
* @return Library version.
* @since 0.0.1
* @note This version may differ from the version the application was compiled
* against.
* @sa #PLIBSYS_VERSION, #PLIBSYS_VERSION_STR, #PLIBSYS_VERSION_CHECK
*/
P_LIB_API const pchar * p_libsys_version (void);
P_END_DECLS
#endif /* PLIBSYS_HEADER_PMAIN_H */
|
