aboutsummaryrefslogtreecommitdiff
path: root/src/NormalizeCaseInsensitiveString.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/NormalizeCaseInsensitiveString.hpp')
-rw-r--r--src/NormalizeCaseInsensitiveString.hpp30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/NormalizeCaseInsensitiveString.hpp b/src/NormalizeCaseInsensitiveString.hpp
new file mode 100644
index 0000000..014dd74
--- /dev/null
+++ b/src/NormalizeCaseInsensitiveString.hpp
@@ -0,0 +1,30 @@
+#ifndef URI_NORMALIZE_CASE_INSENSITIVE_STRING_HPP
+#define URI_NORMALIZE_CASE_INSENSITIVE_STRING_HPP
+
+/**
+ * @file NormalizeCaseInsensitiveString.hpp
+ *
+ * This module declares the Uri::NormalizeCaseInsensitiveString function.
+ *
+ * © 2018 by Richard Walters
+ */
+
+#include <string>
+
+namespace Uri {
+
+ /**
+ * This function takes a string and swaps all upper-case characters
+ * with their lower-case equivalents, returning the result.
+ *
+ * @param[in] inString
+ * This is the string to be normalized.
+ *
+ * @return
+ * The normalized string is returned. All upper-case characters
+ * are replaced with their lower-case equivalents.
+ */
+ std::string NormalizeCaseInsensitiveString(const std::string& inString);
+}
+
+#endif /* URI_NORMALIZE_CASE_INSENSITIVE_STRING_HPP */