summaryrefslogtreecommitdiffstats
path: root/string_pool.h
diff options
context:
space:
mode:
Diffstat (limited to 'string_pool.h')
-rw-r--r--string_pool.h83
1 files changed, 83 insertions, 0 deletions
diff --git a/string_pool.h b/string_pool.h
new file mode 100644
index 0000000..8c28736
--- /dev/null
+++ b/string_pool.h
@@ -0,0 +1,83 @@
+/***************************************************************************
+ * string_pool.h -- String interning for memory optimization *
+ ***********************IMPORTANT NMAP LICENSE TERMS************************
+ *
+ * The Nmap Security Scanner is (C) 1996-2023 Nmap Software LLC ("The Nmap
+ * Project"). Nmap is also a registered trademark of the Nmap Project.
+ *
+ * This program is distributed under the terms of the Nmap Public Source
+ * License (NPSL). The exact license text applying to a particular Nmap
+ * release or source code control revision is contained in the LICENSE
+ * file distributed with that version of Nmap or source code control
+ * revision. More Nmap copyright/legal information is available from
+ * https://nmap.org/book/man-legal.html, and further information on the
+ * NPSL license itself can be found at https://nmap.org/npsl/ . This
+ * header summarizes some key points from the Nmap license, but is no
+ * substitute for the actual license text.
+ *
+ * Nmap is generally free for end users to download and use themselves,
+ * including commercial use. It is available from https://nmap.org.
+ *
+ * The Nmap license generally prohibits companies from using and
+ * redistributing Nmap in commercial products, but we sell a special Nmap
+ * OEM Edition with a more permissive license and special features for
+ * this purpose. See https://nmap.org/oem/
+ *
+ * If you have received a written Nmap license agreement or contract
+ * stating terms other than these (such as an Nmap OEM license), you may
+ * choose to use and redistribute Nmap under those terms instead.
+ *
+ * The official Nmap Windows builds include the Npcap software
+ * (https://npcap.com) for packet capture and transmission. It is under
+ * separate license terms which forbid redistribution without special
+ * permission. So the official Nmap Windows builds may not be redistributed
+ * without special permission (such as an Nmap OEM license).
+ *
+ * Source is provided to this software because we believe users have a
+ * right to know exactly what a program is going to do before they run it.
+ * This also allows you to audit the software for security holes.
+ *
+ * Source code also allows you to port Nmap to new platforms, fix bugs, and add
+ * new features. You are highly encouraged to submit your changes as a Github PR
+ * or by email to the dev@nmap.org mailing list for possible incorporation into
+ * the main distribution. Unless you specify otherwise, it is understood that
+ * you are offering us very broad rights to use your submissions as described in
+ * the Nmap Public Source License Contributor Agreement. This is important
+ * because we fund the project by selling licenses with various terms, and also
+ * because the inability to relicense code has caused devastating problems for
+ * other Free Software projects (such as KDE and NASM).
+ *
+ * The free version of Nmap is distributed in the hope that it will be
+ * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Warranties,
+ * indemnification and commercial support are all available through the
+ * Npcap OEM program--see https://nmap.org/oem/
+ *
+ ***************************************************************************/
+#ifndef STRING_POOL_H
+#define STRING_POOL_H
+
+/* The OS database consists of many small strings, many of which appear
+ thousands of times. It pays to allocate memory only once for each unique
+ string, and have all references point at the one allocated value. */
+
+/* Store a string uniquely. The first time this function is called with a
+ certain string, it allocates memory and stores a copy of the string in a
+ static pool. Thereafter it will return a pointer to the saved string instead
+ of allocating memory for an identical one. */
+const char *string_pool_insert(const char *s);
+
+/* Format a string with sprintf and insert it with string_pool_insert. */
+const char *string_pool_sprintf(const char *fmt, ...);
+
+/* Store the string in the interval [s,t) */
+const char *string_pool_substr(const char *s, const char *t);
+
+/* Store the string in the interval [s,t), stripping whitespace from both ends. */
+const char *string_pool_substr_strip(const char *s, const char *t);
+
+/* Skip over whitespace to find the beginning of a word, then read until the
+ next whitespace character. Returns NULL if only whitespace is found. */
+const char *string_pool_strip_word(const char *s, const char *end);
+
+#endif // STRING_POOL_H