mirror of https://github.com/matrix-construct/construct synced 2024-12-29 08:54:02 +01:00

History

Jason Volk 994916b7eb ircd::buffer: Deconflict buffers templates in separate namespace.		2018-09-13 05:12:10 -07:00
..
buffer	ircd::buffer: Deconflict buffers templates in separate namespace.	2018-09-13 05:12:10 -07:00
cbor
ctx	ircd: Replace any std::uncaught_exception() -> std::uncaught_exceptions().	2018-09-13 05:02:24 -07:00
db	ircd::db: Add custom cache stats ticker.	2018-09-05 03:13:05 -07:00
fs	ircd: Fix std::ios::openmode name.	2018-09-13 05:12:01 -07:00
js
json	ircd::json: Fix exporting path operator<< to ircd:: in include stack here.	2018-09-13 05:02:24 -07:00
m	ircd:Ⓜ️ Add room federate query w/ console indicator.	2018-09-12 23:31:32 -07:00
mods
net
server
util	ircd: Replace any std::uncaught_exception() -> std::uncaught_exceptions().	2018-09-13 05:02:24 -07:00
.gitignore
allocator.h
asio.h
base.h
byte_view.h
client.h
color.h
conf.h	ircd::conf: Add item init callback.	2018-09-03 04:41:14 -07:00
date.h
demangle.h
ed25519.h
exception.h	ircd::exception: Update comment.	2018-09-04 21:09:12 -07:00
fmt.h
hash.h
http.h
info.h	ircd::info: Fix some informational timestamps.	2018-09-05 23:32:52 -07:00
ios.h
iov.h
ircd.h	construct: Add program option to disable direct IO.	2018-09-03 07:59:05 -07:00
js.h
lex_cast.h
localee.h
logger.h
magics.h
Makefile.am
nacl.h
openssl.h
parse.h
rand.h
README.md
resource.h	ircd::resource: Internalize the buffering boilerplate used with json::stack.	2018-09-04 22:03:12 -07:00
rfc1035.h
rfc1459.h
rfc3986.h
spirit.h
stdinc.h
string_view.h
stringops.h	ircd: Fix bug.	2018-09-04 00:43:54 -07:00
tokens.h
vector_view.h

README.md

IRCd Library API

Project Namespaces

IRCD_ Preprocessor #define, macro, and environmental variables.
RB_ Build system related preprocessor #defines and macros (legacy).
ircd_ C namespace and demangled bindings.
ircd:: C++ namespace scope.
X-IRCd- HTTP header key namespace.
ircd. Matrix event type namespace.

What To Include

libircd headers are organized into several aggregates groups

As a C++ project there are a lot of header files. Header files depend on other header files. We don't expect the developer of a compilation unit to figure out an exact list of header files necessary to include for that unit. Instead we have aggregated groups of header files which are then precompiled. These aggregations are mostly oriented around a specific project dependency.

Note: The term 'stack' may be found in place of the preferred term 'group' in other documentation.

Standard Include group <ircd/ircd.h> is the main header group. This group involves the standard library and most of libircd. This is what an embedder will be working with. These headers will expose our own interfaces wrapping 3rd party dependencies which are not included there.

There are actually two files in play here: <ircd/ircd.h> and <ircd/ircd.pic.h>. The latter is generated dynamically and will not exist until make creates it. We have to offer two different pre-compilations: one with -fPIC and one without.
Boost ASIO include group <ircd/asio.h> is a header group exposing the boost::asio library. We only involve this header in compilation units working directly with asio for networking et al. Involving this header file slows down compilation compared with the standard group.
Boost Spirit include group <ircd/spirit.h> is a header group exposing the spirit parser framework to compilation units which involve formal grammars. Involving this header is a monumental slowdown when compiling.
JavaScript include group <ircd/js/js.h> is a header group exposing symbols from the SpiderMonkey JS engine. Alternatively, <ircd/js.h> is part of the standard include group which includes any wrapping to hide SpiderMonkey.
MAPI include group <ircd/mapi.h> is the standard header group for modules. This group is an extension to the standard include group but has specific tools for pluggable modules which are not part of the libircd core.