Update copyright headers.

[user/henk/code/inspircd.git] / make / template / config.h

diff --git a/make/template/config.h b/make/template/config.h
index c1e8bd0fcb72c8bf051743b9a73e5f2b0b031faa..236af5216f3b3f6c6c23953f229dc0ed97e7f349 100644 (file)
--- a/make/template/config.h
+++ b/make/template/config.h
@@ -1,7 +1,7 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2014 Peter Powell <petpow@saberuk.com>
+ *   Copyright (C) 2014, 2016, 2018-2021 Sadie Powell <sadie@witchery.services>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -19,16 +19,46 @@
 
 #pragma once
 
-#define INSPIRCD_BRANCH   "InspIRCd-@VERSION_MAJOR@.@VERSION_MINOR@"
-#define INSPIRCD_VERSION  "InspIRCd-@VERSION_FULL@"
+/** The branch version that is shown to unprivileged users. */
+#define INSPIRCD_BRANCH "InspIRCd-@VERSION_MAJOR@"
 
+/** The full version that is shown to privileged users. */
+#define INSPIRCD_VERSION "InspIRCd-@VERSION_FULL@"
+
+/** Determines whether this version of InspIRCd is older than the requested version. */
+#define INSPIRCD_VERSION_BEFORE(MAJOR, MINOR) (((@VERSION_MAJOR@ << 8) | @VERSION_MINOR@) < ((MAJOR << 8) | (MINOR)))
+
+/** Determines whether this version of InspIRCd is equal to or newer than the requested version. */
+#define INSPIRCD_VERSION_SINCE(MAJOR, MINOR) (((@VERSION_MAJOR@ << 8) | @VERSION_MINOR@) >= ((MAJOR << 8) | (MINOR)))
+
+/** The default location that config files are stored in. */
 #define INSPIRCD_CONFIG_PATH "@CONFIG_DIR@"
-#define INSPIRCD_DATA_PATH   "@DATA_DIR@"
-#define INSPIRCD_LOG_PATH    "@LOG_DIR@"
+
+/** The default location that data files are stored in. */
+#define INSPIRCD_DATA_PATH "@DATA_DIR@"
+
+/** The default location that log files are stored in. */
+#define INSPIRCD_LOG_PATH "@LOG_DIR@"
+
+/** The default location that module files are stored in. */
 #define INSPIRCD_MODULE_PATH "@MODULE_DIR@"
 
+/** The default location that runtime files are stored in. */
+#define INSPIRCD_RUNTIME_PATH "@RUNTIME_DIR@"
+
+/** The URL of the InspIRCd docs site. */
+#define INSPIRCD_DOCS "https://docs.inspircd.org/@VERSION_MAJOR@/"
+
 #ifndef _WIN32
  %target include/config.h
+
+ /** Whether the arc4random_buf() function was available at compile time. */
+ %define HAS_ARC4RANDOM_BUF
+
+ /** Whether the clock_gettime() function was available at compile time. */
  %define HAS_CLOCK_GETTIME
+
+ /** Whether the eventfd() function was available at compile time. */
  %define HAS_EVENTFD
+
 #endif