0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-15 22:41:12 +01:00
construct/include/ircd
2022-07-26 15:46:09 -07:00
..
buffer ircd::buffer: Add explicit checked convenience type casts. 2022-07-07 16:47:55 -07:00
cl ircd::util: Fix undefined-var-template linkage related warning. 2022-07-20 12:31:49 -07:00
ctx ircd::ctx::dock: Eliminate inlined template complex; optimize linkages. 2022-06-29 18:20:46 -07:00
db ircd::db: Fix additional db::prefetcher shutdown. (related cd15c17499) 2022-07-13 22:48:14 -07:00
fs ircd: Upgrade to std::filesystem from boost::filesystem. 2022-07-07 16:47:55 -07:00
gpt ircd::gpt: Fix stale comment. [ci skip]. 2022-07-22 19:11:51 -07:00
http2
ios ircd::ios: Consolidate notification interface for now; add atexit related. 2022-06-29 18:20:46 -07:00
js
json ircd::json: Add prepend/append tools for arrays. 2022-07-13 22:48:14 -07:00
m modules/client/search: Add case key command; case-insensitive by default. 2022-07-21 18:28:57 -07:00
math ircd: Vector initialization fixes for GCC. 2021-05-14 05:57:47 -07:00
mods ircd::mods: Improve paths encapsulation; fix warning. (gcc-12) 2022-07-04 22:25:18 -07:00
net ircd::net::acceptor: Add filter instance stub to listener. 2022-07-08 10:45:33 -07:00
prof Revert "ircd: ISO C++ requires template on destructor names out-of-line." (gcc-11/12) 2022-06-20 17:26:39 -07:00
resource ircd::resource: Implement more complex path routing. 2022-07-20 09:56:22 -07:00
server ircd::server: Remove problematic tag move assignment operator. 2022-07-08 15:21:47 -07:00
simd ircd: Ensure initialized values in conditionals (pedantic; llvm). 2022-06-17 21:11:54 -07:00
simt ircd::simt: Store divisor in mean state for now. 2022-06-19 20:14:22 -07:00
spirit ircd::spirit: Replace deprecated phoenix header. 2022-07-25 12:31:18 -07:00
util ircd::util: Fix unsafe instance_list emplace; assert for allocator state. 2022-07-20 18:32:38 -07:00
.gitignore
allocator.h ircd: Various symbol surface reductions and sorting. 2022-06-17 21:11:53 -07:00
asio.h ircd::asio: Fix undefined-var-template error; enable -fpch-instantiate-templates. 2022-07-20 18:32:38 -07:00
assert.h ircd: Add branchless optimistic assertion instrument --with-assert=opt 2022-07-18 16:58:02 -07:00
b58.h
b64.h
backtrace.h
beep.h ircd::fs: Eliminate user-defined ctors on various opts for designated inits. 2022-06-19 20:27:13 -07:00
byte_view.h ircd: Add template option to skip runtime conditional in byte_view conversion. 2020-09-17 10:49:41 -07:00
cbor.h
client.h ircd::client: Encapsulation related reorg; still needs more work. 2022-06-17 21:11:54 -07:00
cmp.h ircd: Split out overgrown components from stringops.h 2019-07-11 15:51:09 -07:00
color.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
conf.h ircd::conf: Add environ() to interface; minor cleanup/reorg. 2022-07-11 12:53:25 -07:00
crh.h Convert static member constexprs to non-reference type. 2022-06-28 17:42:49 -07:00
demangle.h ircd: Move demangle() out of util. 2019-09-19 16:37:45 -07:00
ed25519.h ircd::ed25519: Add create option to ctor; remove reference to global. 2020-09-15 18:46:28 -07:00
exception.h ircd::exception: Move throwing errno+system_category out-of-line. 2022-07-08 11:39:45 -07:00
exec.h ircd::exec: Implement callback handler suite; async wait(). 2020-10-24 05:41:46 -07:00
fmt.h ircd: Various symbol internalizing and PLT reductions. 2022-06-17 21:11:54 -07:00
fpe.h ircd::fpe: Add debug log info; cold sections. 2022-06-17 21:11:53 -07:00
globular.h
grammar.h ircd: Forward declare missing karma::rule; ensure visibility of public rules. 2022-06-28 12:37:14 -07:00
http.h Fix missing virtual destructor override indications (pedantic). 2022-06-17 21:11:54 -07:00
icu.h ircd::icu: Add bulk vector utility overloads. 2021-02-25 14:38:52 -08:00
info.h ircd: Split info::versions into header/unit. 2022-06-23 10:50:48 -07:00
iov.h
ircd.h ircd: Split stduse.h from stdinc.h. 2022-07-08 10:45:33 -07:00
js.h
leb128.h ircd::leb128: Add RB_GENERIC condition on platform intrinsics. 2019-12-21 14:37:41 -08:00
lex_cast.h ircd: Add hours/minutes to lex_cast specialization suite. 2022-06-17 21:11:53 -07:00
logger.h ircd::log: Cold section log::critical constructions. 2022-07-26 15:46:09 -07:00
magic.h ircd: Various symbol surface reductions and sorting. 2022-06-17 21:11:53 -07:00
magick.h ircd: Define all IRCD_USE_ as integers for constexprs. 2022-06-23 09:36:44 -07:00
Makefile.am Makefiles: Fix bashisms. (#88) 2022-07-25 14:08:26 -07:00
matrix.h
nacl.h
openssl.h ircd::openssl: Fix argument narrowing from default constants. 2022-06-17 21:11:54 -07:00
panic.h ircd: Various symbol internalizing and PLT reductions. 2022-06-17 21:11:54 -07:00
parse.h
pbc.h ircd: Add PBC stub. 2020-02-11 15:47:18 -08:00
png.h ircd::png: Elaborate callback surface; add logger to prevent libpng writes to stderr. 2021-01-23 10:57:01 -08:00
portable.h ircd::spirit: Fix missing include guard/pragma; minor cleanup/comments. 2022-06-17 21:11:53 -07:00
rand.h ircd::rand: Remove inline noexcepts. 2021-02-27 13:01:02 -08:00
README.md
rfc1035.h ircd: Fixes for macro collision (gnu++20). 2022-06-19 20:14:23 -07:00
rfc1459.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
rfc3986.h ircd: Forward declare missing karma::rule; ensure visibility of public rules. 2022-06-28 12:37:14 -07:00
run.h ircd::util: Fix undefined-var-template linkage related warning. 2022-07-20 12:31:49 -07:00
spirit.h ircd::spirit: Split substring_view into header. 2022-06-17 21:11:54 -07:00
stats.h ircd::stats: Add signed integer, chrono specializations; use panic exception. 2020-12-23 03:56:43 -08:00
stdinc.h ircd: Split stduse.h from stdinc.h. 2022-07-08 10:45:33 -07:00
stduse.h ircd: Split stduse.h from stdinc.h. 2022-07-08 10:45:33 -07:00
string_view.h ircd::string_view: Attribute noreturn on insert() stub under proper conditions. 2022-07-20 18:32:38 -07:00
stringops.h ircd::string_view: Add noexcept substr(); optimize codegen for split()/rsplit(). 2022-07-18 16:58:02 -07:00
strl.h ircd::strl: Simplify strlcat; reuse strlcpy. (related f705df096d). 2022-07-03 15:04:02 -07:00
strn.h
sys.h ircd::exception: Move throwing errno+system_category out-of-line. 2022-07-08 11:39:45 -07:00
terminate.h ircd: Improve terminate interface; simplify impl. 2020-12-13 10:45:34 -08:00
time.h ircd: Fix/improve comments. [ci skip] 2020-12-06 10:36:47 -08:00
tokens.h ircd: Add tokens_split() tool w/ skip feature. 2022-07-19 14:26:23 -07:00
utf8.h ircd::utf: Split header; improve decode codegen; inline length. 2021-09-14 23:39:55 -07:00
utf16.h ircd::utf: Split header; improve decode codegen; inline length. 2021-09-14 23:39:55 -07:00
vector_view.h ircd::vector_view: Add constexpr constructions. 2022-07-12 22:36:50 -07:00
versions.h ircd::versions: Declare list specialization; noexcept ctors; minor cleanup. 2022-07-20 18:32:38 -07:00
vg.h ircd::vg: Add template convenience defined(); improve call interface. 2022-06-17 21:11:54 -07:00

IRCd Library API

Project Namespaces

  • IRCD_ Preprocessor #define and macros.
  • 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.
  • ircd_ Environmental variables (see: conf.h).

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.

Invocation

libircd is not thread-safe. It does not protect exposed interfaces with locks. Embedders must access libircd from a single thread.

Initialize the library with a call to ircd::init().