summaryrefslogtreecommitdiff
path: root/utils/messages.h
diff options
context:
space:
mode:
Diffstat (limited to 'utils/messages.h')
-rw-r--r--utils/messages.h29
1 files changed, 29 insertions, 0 deletions
diff --git a/utils/messages.h b/utils/messages.h
new file mode 100644
index 0000000..33b2fc3
--- /dev/null
+++ b/utils/messages.h
@@ -0,0 +1,29 @@
+/*
+ * This file is part of NetSurf, http://netsurf.sourceforge.net/
+ * Licensed under the GNU General Public License,
+ * http://www.opensource.org/licenses/gpl-license
+ * Copyright 2004 James Bursa <bursa@users.sourceforge.net>
+ */
+
+/** \file
+ * Localised message support (interface).
+ *
+ * The messages module loads a file of keys and associated strings, and
+ * provides fast lookup by key. The messages file consists of key:value lines,
+ * comment lines starting with #, and other lines are ignored. Use
+ * messages_load() to read the file into memory. To lookup a key, use
+ * messages_get("key").
+ *
+ * Only the first MAX_KEY_LENGTH (currently 24) characters of the key are
+ * significant.
+ */
+
+#ifndef _NETSURF_UTILS_MESSAGES_H_
+#define _NETSURF_UTILS_MESSAGES_H_
+
+void messages_load(const char *path);
+const char *messages_get(const char *key);
+const char *messages_get_key(const char *value);
+void messages_dump(void);
+
+#endif