threads / patch / 12633

patchhelp: implement multi-valued "man.viewer" config option

Subject: [PATCH] help: implement multi-valued "man.viewer" config option

## tl;dr

6 messages between Mar 11, 2008 and Mar 15, 2008. Diffs are folded; open one to read it.

replies: 5people: 2as markdown or json

Christian Couder· Mar 11, 2008, 07:51 UTC · lore
Junio suggested:
Show 28 quoted lines
> How about allowing multi-valued man.viewer like this:
>
>        [man]
>                viewer = woman
>                viewer = konqueror
>                viewer = man
>
> and have:
>
>        static struct man_viewer {
>                char *name;
>                void (*exec)(const char *);
>        } viewers[] = {
>                { "woman", exec_woman },
>                { "konqueror", exec_konqueror },
>                { "man", exec_man },
>                { NULL, },
>        };
>
> Then you can iterate the man.viewer values, ask the viewer's
> exec() function to show the page (or return when it is not
> in an environment that it can be useful).
>
> show_man_page() would become:
>
>        for (each viewer in user's config)
>                viewer.exec(page); /* will return when unable */
>        die("no man viewer handled the request");

This patch implements the above using a list of exec functions that is filled when reading the config.

To do that the exec functions have been moved before reading the config. This makes the patch much longer than it would be otherwise.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 help.c |  191 ++++++++++++++++++++++++++++++++++++++--------------------------
 1 files changed, 113 insertions(+), 78 deletions(-)
	This is on top of my previous "man.viewer" patches:
	[PATCH 1/2] help: add "man.viewer" config var to use "woman" or "konqueror"
	[PATCH 2/2] Documentation: help: describe 'man.viewer' config variable
Show changes to help.c +113 −78
diff --git a/help.c b/help.c
index 2cb152d..5da8c9c 100644
--- a/help.c
+++ b/help.c
@@ -10,7 +10,10 @@
 #include "parse-options.h"
 #include "run-command.h"
 
-static const char *man_viewer;
+static struct man_viewer_list {
+	void (*exec)(const char *);
+	struct man_viewer_list *next;
+} *man_viewer_list;
 
 enum help_format {
 	HELP_FORMAT_MAN,
@@ -45,6 +48,102 @@ static enum help_format parse_help_format(const char *format)
 	die("unrecognized help format '%s'", format);
 }
 
+static int check_emacsclient_version(void)
+{
+	struct strbuf buffer = STRBUF_INIT;
+	struct child_process ec_process;
+	const char *argv_ec[] = { "emacsclient", "--version", NULL };
+	int version;
+
+	/* emacsclient prints its version number on stderr */
+	memset(&ec_process, 0, sizeof(ec_process));
+	ec_process.argv = argv_ec;
+	ec_process.err = -1;
+	ec_process.stdout_to_stderr = 1;
+	if (start_command(&ec_process)) {
+		fprintf(stderr, "Failed to start emacsclient.\n");
+		return -1;
+	}
+	strbuf_read(&buffer, ec_process.err, 20);
+	close(ec_process.err);
+
+	/*
+	 * Don't bother checking return value, because "emacsclient --version"
+	 * seems to always exits with code 1.
+	 */
+	finish_command(&ec_process);
+
+	if (prefixcmp(buffer.buf, "emacsclient")) {
+		fprintf(stderr, "Failed to parse emacsclient version.\n");
+		strbuf_release(&buffer);
+		return -1;
+	}
+
+	strbuf_remove(&buffer, 0, strlen("emacsclient"));
+	version = atoi(buffer.buf);
+
+	if (version < 22) {
+		fprintf(stderr,
+			"emacsclient version '%d' too old (< 22).\n",
+			version);
+		strbuf_release(&buffer);
+		return -1;
+	}
+
+	strbuf_release(&buffer);
+	return 0;
+}
+
+static void exec_woman_emacs(const char *page)
+{
+	if (!check_emacsclient_version()) {
+		/* This works only with emacsclient version >= 22. */
+		struct strbuf man_page = STRBUF_INIT;
+		strbuf_addf(&man_page, "(woman \"%s\")", page);
+		execlp("emacsclient", "emacsclient", "-e", man_page.buf, NULL);
+	}
+}
+
+static void exec_man_konqueror(const char *page)
+{
+	const char *display = getenv("DISPLAY");
+	if (display && *display) {
+		struct strbuf man_page = STRBUF_INIT;
+		strbuf_addf(&man_page, "man:%s(1)", page);
+		execlp("kfmclient", "kfmclient", "newTab", man_page.buf, NULL);
+	}
+}
+
+static void exec_man_man(const char *page)
+{
+	execlp("man", "man", page, NULL);
+}
+
+static void do_add_man_viewer(void (*exec)(const char *))
+{
+	struct man_viewer_list **p = &man_viewer_list;
+
+	while (*p)
+		p = &((*p)->next);
+	*p = xmalloc(sizeof(**p));
+	(*p)->next = NULL;
+	(*p)->exec = exec;
+}
+
+static int add_man_viewer(const char *value)
+{
+	if (!strcasecmp(value, "man"))
+		do_add_man_viewer(exec_man_man);
+	else if (!strcasecmp(value, "woman"))
+		do_add_man_viewer(exec_woman_emacs);
+	else if (!strcasecmp(value, "konqueror"))
+		do_add_man_viewer(exec_man_konqueror);
+	else
+		return error("'%s': unsupported man viewer.", value);
+
+	return 0;
+}
+
 static int git_help_config(const char *var, const char *value)
 {
 	if (!strcmp(var, "help.format")) {
@@ -53,8 +152,11 @@ static int git_help_config(const char *var, const char *value)
 		help_format = parse_help_format(value);
 		return 0;
 	}
-	if (!strcmp(var, "man.viewer"))
-		return git_config_string(&man_viewer, var, value);
+	if (!strcmp(var, "man.viewer")) {
+		if (!value)
+			return config_error_nonbool(var);
+		return add_man_viewer(value);
+	}
 	return git_default_config(var, value);
 }
 
@@ -350,85 +452,18 @@ static void setup_man_path(void)
 	strbuf_release(&new_path);
 }
 
-static int check_emacsclient_version(void)
-{
-	struct strbuf buffer = STRBUF_INIT;
-	struct child_process ec_process;
-	const char *argv_ec[] = { "emacsclient", "--version", NULL };
-	int version;
-
-	/* emacsclient prints its version number on stderr */
-	memset(&ec_process, 0, sizeof(ec_process));
-	ec_process.argv = argv_ec;
-	ec_process.err = -1;
-	ec_process.stdout_to_stderr = 1;
-	if (start_command(&ec_process)) {
-		fprintf(stderr, "Failed to start emacsclient.\n");
-		return -1;
-	}
-	strbuf_read(&buffer, ec_process.err, 20);
-	close(ec_process.err);
-
-	/*
-	 * Don't bother checking return value, because "emacsclient --version"
-	 * seems to always exits with code 1.
-	 */
-	finish_command(&ec_process);
-
-	if (prefixcmp(buffer.buf, "emacsclient")) {
-		fprintf(stderr, "Failed to parse emacsclient version.\n");
-		strbuf_release(&buffer);
-		return -1;
-	}
-
-	strbuf_remove(&buffer, 0, strlen("emacsclient"));
-	version = atoi(buffer.buf);
-
-	if (version < 22) {
-		fprintf(stderr,
-			"emacsclient version '%d' too old (< 22).\n",
-			version);
-		strbuf_release(&buffer);
-		return -1;
-	}
-
-	strbuf_release(&buffer);
-	return 0;
-}
-
-static void exec_woman_emacs(const char *page)
-{
-	if (!check_emacsclient_version()) {
-		/* This works only with emacsclient version >= 22. */
-		struct strbuf man_page = STRBUF_INIT;
-		strbuf_addf(&man_page, "(woman \"%s\")", page);
-		execlp("emacsclient", "emacsclient", "-e", man_page.buf, NULL);
-	} else
-		execlp("man", "man", page, NULL);
-}
-
-static void exec_man_konqueror(const char *page)
-{
-	const char *display = getenv("DISPLAY");
-	if (display && *display) {
-		struct strbuf man_page = STRBUF_INIT;
-		strbuf_addf(&man_page, "man:%s(1)", page);
-		execlp("kfmclient", "kfmclient", "newTab", man_page.buf, NULL);
-	} else
-		execlp("man", "man", page, NULL);
-}
-
 static void show_man_page(const char *git_cmd)
 {
+	struct man_viewer_list *viewer;
 	const char *page = cmd_to_page(git_cmd);
+
 	setup_man_path();
-	if (!man_viewer || !strcmp(man_viewer, "man"))
-		execlp("man", "man", page, NULL);
-	if (!strcmp(man_viewer, "woman"))
-		exec_woman_emacs(page);
-	if (!strcmp(man_viewer, "konqueror"))
-		exec_man_konqueror(page);
-	die("'%s': unsupported man viewer.", man_viewer);
+	for (viewer = man_viewer_list; viewer; viewer = viewer->next)
+	{
+		viewer->exec(page); /* will return when unable */
+	}
+	exec_man_man(page);
+	die("no man viewer handled the request");
 }
 
 static void show_info_page(const char *git_cmd)
-- 
1.5.4.4.595.g9c65
Xavier Maillard· Mar 12, 2008, 01:00 UTC · re: Christian Couder · lore

Re: [PATCH] help: implement multi-valued "man.viewer" config option

   Junio suggested:
   > How about allowing multi-valued man.viewer like this:
   >
   >        [man]
   >                viewer = woman
   >                viewer = konqueror
   >                viewer = man
   >
   > and have:
   >
   >        static struct man_viewer {
   >                char *name;
   >                void (*exec)(const char *);
   >        } viewers[] = {
   >                { "woman", exec_woman },
   >                { "konqueror", exec_konqueror },
   >                { "man", exec_man },
   >                { NULL, },
   >        };
   >
   > Then you can iterate the man.viewer values, ask the viewer's
   > exec() function to show the page (or return when it is not
   > in an environment that it can be useful).
   >
   > show_man_page() would become:
   >
   >        for (each viewer in user's config)
   >                viewer.exec(page); /* will return when unable */
   >        die("no man viewer handled the request");
   This patch implements the above using a list of exec functions that
   is filled when reading the config.
   To do that the exec functions have been moved before reading the
   config. This makes the patch much longer than it would be otherwise.
   Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Tested-by: Xavier Maillard <xma@gnu.org>

Though, I thought that when one entry had failed we would have switched to the next until none could be found thus

I (voluntary) made a typo in my .git/config file as reflected by:

[xma@localhost 23:57:18 git]$ git config --get-all man.viewer woma <- TYPO HERE konqueror man

and I then tried git config --help. I thought it would have tried all entries and as a last resort would have failed back to man but it did not act like this:

[xma@localhost 23:57:11 git]$ git config --help error: 'woma': unsupported man viewer. fatal: bad config file line 16 in .git/config

Ok, woma in not supported here and it is reported like this but would it be possible to just throw an error on stdout and try another viewer ? We could even imagine something even more general like the possibility for the user to write his own man viewer (a bash script for example) and set it as a candidate.

By the way, I do not see any reason to put man as a candidate. "man" should be the default when nothing is specified or when all candidates have failed.

Anyway, thank you for this implementation.
	Xavier
-- 
http://www.gnu.org
http://www.april.org
http://www.lolica.org
Christian Couder· Mar 12, 2008, 07:23 UTC · re: Xavier Maillard · lore

Re: [PATCH] help: implement multi-valued "man.viewer" config option

Le mercredi 12 mars 2008, Xavier Maillard a écrit :
>
> Tested-by: Xavier Maillard <xma@gnu.org>
Thanks.
Show 21 quoted lines
> Though, I thought that when one entry had failed we would have
> switched to the next until none could be found thus
>
> I (voluntary) made a typo in my .git/config file as reflected by:
>
> [xma@localhost 23:57:18 git]$ git config --get-all man.viewer
> woma  <- TYPO HERE
> konqueror
> man
>
> and I then tried git config --help. I thought it would have tried
> all entries and as a last resort would have failed back to man
> but it did not act like this:
>
> [xma@localhost 23:57:11 git]$ git config --help
> error: 'woma': unsupported man viewer.
> fatal: bad config file line 16 in .git/config
>
> Ok, woma in not supported here and it is reported like this but
> would it be possible to just throw an error on stdout and try
> another viewer ? 
Yes, with the following patch on top:
Show changes to help.c +1 −1
diff --git a/help.c b/help.c
index 5da8c9c..ecaca77 100644
--- a/help.c
+++ b/help.c
@@ -139,7 +139,7 @@ static int add_man_viewer(const char *value)
        else if (!strcasecmp(value, "konqueror"))
                do_add_man_viewer(exec_man_konqueror);
        else
-               return error("'%s': unsupported man viewer.", value);
+               warning("'%s': unsupported man viewer.", value);

        return 0;
 }

> We could even imagine something even more 
> general like the possibility for the user to write his own man
> viewer (a bash script for example) and set it as a candidate.

I will do that in a latter patch, it has been suggested a lot of times 
already.

> By the way, I do not see any reason to put man as a candidate.
> "man" should be the default when nothing is specified or when all
> candidates have failed.

It may be more explicit.

Thanks,
Christian.

> Anyway, thank you for this implementation.
>
> 	Xavier
Xavier Maillard· Mar 14, 2008, 01:00 UTC · re: Christian Couder · lore

Re: [PATCH] help: implement multi-valued "man.viewer" config option

   > Ok, woma in not supported here and it is reported like this but
   > would it be possible to just throw an error on stdout and try
   > another viewer ? 
   Yes, with the following patch on top:
See my "tested-by" message.
   > We could even imagine something even more 
   > general like the possibility for the user to write his own man
   > viewer (a bash script for example) and set it as a candidate.
   I will do that in a latter patch, it has been suggested a lot of times 
   already.
Glad to read that !
   > By the way, I do not see any reason to put man as a candidate.
   > "man" should be the default when nothing is specified or when all
   > candidates have failed.
   It may be more explicit.

Well, I do not buy this argument and I am pretty sure that a simple note into the manual would suffice but, that's me :)

	Xavier
-- 
http://www.gnu.org
http://www.april.org
http://www.lolica.org
Christian Couder· Mar 14, 2008, 05:26 UTC · re: Xavier Maillard · lore

Re: [PATCH] help: implement multi-valued "man.viewer" config option

Le vendredi 14 mars 2008, Xavier Maillard a écrit :
Show 7 quoted lines
>    > Ok, woma in not supported here and it is reported like this but
>    > would it be possible to just throw an error on stdout and try
>    > another viewer ?
>
>    Yes, with the following patch on top:
>
> See my "tested-by" message.
Thank you Xavier for this message.
Show 8 quoted lines
>    > We could even imagine something even more
>    > general like the possibility for the user to write his own man
>    > viewer (a bash script for example) and set it as a candidate.
>
>    I will do that in a latter patch, it has been suggested a lot of times
>    already.
>
> Glad to read that !

I just sent a patch to do that in "git-web--browse.sh" and I will soon work on the same stuff for man viewing.

Show 8 quoted lines
>    > By the way, I do not see any reason to put man as a candidate.
>    > "man" should be the default when nothing is specified or when all
>    > candidates have failed.
>
>    It may be more explicit.
>
> Well, I do not buy this argument and I am pretty sure that a
> simple note into the manual would suffice but, that's me :)

As my patch is now on next and as I am not sure to understand exactly what you want, I can only suggest to send a patch if you really care.

Thanks, Christian.

Xavier Maillard· Mar 15, 2008, 13:00 UTC · re: Christian Couder · lore

Re: [PATCH] help: implement multi-valued "man.viewer" config option

   >    I will do that in a latter patch, it has been suggested a lot of times
   >    already.
   >
   > Glad to read that !
   I just sent a patch to do that in "git-web--browse.sh" and I will soon work 
   on the same stuff for man viewing.
Seen it and I am about to test it ;)
   > Well, I do not buy this argument and I am pretty sure that a
   > simple note into the manual would suffice but, that's me :)
   As my patch is now on next and as I am not sure to understand exactly what 
   you want, I can only suggest to send a patch if you really care.

I could but I won't: no time and most importantly, who really care except me ? :) It is okay for me as is (I can certainly live with that).

Regards
	Xavier
-- 
http://www.gnu.org
http://www.april.org
http://www.lolica.org

← back to recent threads