summaryrefslogtreecommitdiffstats
path: root/src/descriptions_store.c
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 01:16:24 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 01:16:24 +0000
commit9221dca64f0c8b5de72727491e41cf63e902eaab (patch)
treed8cbbf520eb4b5c656a54b2e36947008dcb751ad /src/descriptions_store.c
parentInitial commit. (diff)
downloadman-db-9221dca64f0c8b5de72727491e41cf63e902eaab.tar.xz
man-db-9221dca64f0c8b5de72727491e41cf63e902eaab.zip
Adding upstream version 2.8.5.upstream/2.8.5upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/descriptions_store.c')
-rw-r--r--src/descriptions_store.c148
1 files changed, 148 insertions, 0 deletions
diff --git a/src/descriptions_store.c b/src/descriptions_store.c
new file mode 100644
index 0000000..c473aee
--- /dev/null
+++ b/src/descriptions_store.c
@@ -0,0 +1,148 @@
+/*
+ * descriptions_store.c: store man page descriptions in database
+ *
+ * Copyright (C) 2002, 2003, 2006, 2007, 2008, 2011 Colin Watson.
+ *
+ * This file is part of man-db.
+ *
+ * man-db is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * man-db 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. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with man-db; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif /* HAVE_CONFIG_H */
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+
+#include "gettext.h"
+#define _(String) gettext (String)
+
+#include "manconfig.h"
+
+#include "error.h"
+
+#include "db_storage.h"
+
+#include "filenames.h"
+#include "ult_src.h"
+#include "descriptions.h"
+
+static void gripe_bad_store (const char *name, const char *ext)
+{
+ if (quiet < 2)
+ error (0, 0, _("warning: failed to store entry for %s(%s)"),
+ name, ext);
+}
+
+/* Is PATH a prefix of DIR, such that DIR is in the manual hierarchy PATH?
+ * This requires that the part of DIR following PATH start with "/man".
+ */
+static int is_prefix (const char *path, const char *dir)
+{
+ return (STRNEQ (dir, path, strlen (path)) &&
+ STRNEQ (dir + strlen (path), "/man", 4));
+}
+
+/* Take a list of descriptions returned by parse_descriptions() and store
+ * it into the database.
+ */
+void store_descriptions (MYDBM_FILE dbf, const struct page_description *head,
+ struct mandata *info,
+ const char *path, const char *base,
+ struct ult_trace *trace)
+{
+ const struct page_description *desc;
+ char save_id = info->id;
+ size_t i;
+
+ if (trace) {
+ for (i = 0; i < trace->len; ++i)
+ debug ("trace->names[%zu] = '%s'\n",
+ i, trace->names[i]);
+ }
+
+ for (desc = head; desc; desc = desc->next) {
+ /* Either it's the real thing or merely a reference. Get the
+ * id and pointer right in either case.
+ */
+ int found_real_page = 0;
+ int found_external = 0;
+
+ if (STREQ (base, desc->name)) {
+ info->id = save_id;
+ info->pointer = NULL;
+ info->whatis = desc->whatis;
+ found_real_page = 1;
+ } else if (trace) {
+ for (i = 0; i < trace->len; ++i) {
+ struct mandata trace_info;
+ char *buf;
+
+ buf = filename_info (trace->names[i],
+ &trace_info, "");
+ if (trace_info.name &&
+ STREQ (trace_info.name, desc->name)) {
+ if (path && !is_prefix (path, buf)) {
+ /* Link outside this manual
+ * hierarchy; skip this
+ * description.
+ */
+ found_external = 1;
+ free (trace_info.name);
+ free (buf);
+ break;
+ }
+ if (i == trace->len - 1 &&
+ save_id == SO_MAN)
+ info->id = ULT_MAN;
+ else
+ info->id = save_id;
+ info->pointer = NULL;
+ info->whatis = desc->whatis;
+ found_real_page = 1;
+ }
+
+ free (trace_info.name);
+ free (buf);
+ }
+ }
+
+ if (found_external) {
+ debug ("skipping '%s'; link outside manual "
+ "hierarchy\n", desc->name);
+ continue;
+ }
+
+ if (!found_real_page) {
+ if (save_id < STRAY_CAT)
+ info->id = WHATIS_MAN;
+ else
+ info->id = WHATIS_CAT;
+ info->pointer = xstrdup (base);
+ /* Don't waste space storing the whatis in the db
+ * more than once.
+ */
+ info->whatis = NULL;
+ }
+
+ debug ("name = '%s', id = %c\n", desc->name, info->id);
+ if (dbstore (dbf, info, desc->name) > 0) {
+ gripe_bad_store (base, info->ext);
+ break;
+ }
+ }
+}