common: Unify Date/Time formatting, UTC offset

[quassel.git] / src / common / util.h

diff --git a/src/common/util.h b/src/common/util.h
index 632ba0e..514c564 100644 (file)
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -79,3 +79,49 @@ QByteArray prettyDigest(const QByteArray &digest);
  * @return String with current date/time substituted in via formatting codes
  */
 QString formatCurrentDateTimeInString(const QString &formatStr);
+
+/** Check if a scope rule matches a string
+ *
+ * When isRegEx is false:
+ * Checks that the string does NOT match ANY inverted rules (prefixed by '!'), then checks that
+ * it matches AT LEAST one normal (non-inverted) rule.
+ *
+ * If only inverted rules are specified, it'll match so long as the string does not match any
+ * inverted rules (implicit wildcard).
+ *
+ * When isRegEx is true:
+ * Checks that the string matches the entire scopeRule as a regular expression.  If scopeRule starts
+ * with a '!', check that the string does NOT match the regular expression.
+ *
+ * @param string           String to test, e.g. network/channel name
+ * @param scopeRule        ';'-separated list of wildcard expressions, prefix of '!' inverts subrule
+ * @param isRegEx          If true, treat entire scope rule as regular expression, not wildcards
+ * @param isCaseSensitive  If true, treat as case-sensitive, else case-insensitive
+ * @return True if matches, otherwise false
+ */
+bool scopeMatch(const QString &string, const QString &scopeRule,
+                const bool &isRegEx = false, const bool &isCaseSensitive = false);
+
+/**
+ * Try to localize a given date/time in seconds from Unix epoch, pass through string if invalid
+ *
+ * Allows compatibility with date/time fields that may or may not be in Unix epoch format,
+ * localizing if possible, leaving alone if not.
+ *
+ * @param possibleEpochDate Date/time that might be in seconds since Unix epoch format
+ * @param dateFormat        Desired format of the date/time string
+ * @param useUTC            If true, use UTC timezone, otherwise use local time
+ * @return Localized date/time if parse succeeded, otherwise the source string
+ */
+QString tryFormatUnixEpoch(const QString &possibleEpochDate,
+                           Qt::DateFormat dateFormat = Qt::DateFormat::TextDate,
+                           bool useUTC = false);
+
+
+/**
+ * Format the given date/time in ISO 8601 format with timezone offset
+ *
+ * @param dateTime Date/time of interest
+ * @return Date/time in ISO 8601 format with timezone offset
+ */
+QString formatDateTimeToOffsetISO(const QDateTime &dateTime);