socat V1.6.0.0 (initial GIT commit)

2025-07-08 21:36:34 +00:00 · 2008-01-27 13:00:08 +01:00 · 2008-01-27 13:00:08 +01:00 · b819572f5e
commit b819572f5e
170 changed files with 59193 additions and 0 deletions
--- a/xiohelp.c
+++ b/xiohelp.c
@ -0,0 +1,168 @@
+/* $Id: xiohelp.c,v 1.19 2007/02/05 21:07:07 gerhard Exp $ */
+/* Copyright Gerhard Rieger 2001-2007 */
+/* Published under the GNU General Public License V.2, see file COPYING */
+
+/* this file contains the source for the help function */
+
+#include "xiosysincludes.h"
+#include "xioopen.h"
+
+#include "xiohelp.h"
+
+#if WITH_HELP
+
+/* keep consistent with xioopts.h:enum e_types ! */
+static const char *optiontypenames[] = {
+	"CONST",	"BIN",		"BOOL",		"BYTE",
+	"INT",		"LONG",		"STRING",	"PTRDIFF",
+	"SHORT",	"SIZE_T",	"SOCKADDR",	"UNSIGNED-INT",
+	"UNSIGNED-LONG","UNSIGNED-SHORT","MODE_T",	"GID_T",
+	"UID_T",	"INT[3]",	"STRUCT-TIMEVAL", "STRUCT-TIMESPEC",
+#if HAVE_STRUCT_LINGER
+	"STRUCT-LINGER",
+#endif
+			"DOUBLE",	"STRING-NULL",	"LONG-LONG",
+	"OFF_T",	"OFF64_T",
+#if HAVE_STRUCT_IP_MREQN
+					"STRUCT-IP_MREQN",
+#elif HAVE_STRUCT_IP_MREQN
+					"STRUCT-IP_MREQ",
+#endif
+							"IP4NAME",
+} ;
+
+
+/* keep consistent with xioopts.h:#define GROUP_* ! */
+static const char *addressgroupnames[] = {
+	"FD",		"FIFO",		"CHR",		"BLK",
+	"REG",		"SOCKET",	"READLINE",	"undef",
+	"NAMED",	"OPEN",		"EXEC",		"FORK",
+	"LISTEN",	"DEVICE",	"CHILD",	"RETRY",
+	"TERMIOS",	"RANGE",	"PTY",		"PARENT",
+	"UNIX",		"IP4",		"IP6",		"INTERFACE",
+	"UDP",		"TCP",		"SOCKS4",	"OPENSSL",
+	"PROCESS",	"APPL",		"HTTP",		"undef"
+} ;
+
+
+/* keep consistent with xioopts.h:enum ephase ! */
+static char *optionphasenames[] = {
+	"ALL",		"INIT",		"EARLY",
+	"PREOPEN",	"OPEN",		"PASTOPEN",
+	"PRESOCKET",	"SOCKET",	"PASTSOCKET",
+	"PREBIGEN",	"BIGEN",	"PASTBIGEN",
+	"FD",
+	"PREBIND",	"BIND",		"PASTBIND",	
+	"PRELISTEN",	"LISTEN",	"PASTLISTEN",
+	"PRECONNECT",	"CONNECT",	"PASTCONNECT",
+	"PREACCEPT",	"ACCEPT",	"PASTACCEPT",
+	"CONNECTED",
+	"PREFORK",	"FORK",		"PASTFORK",
+	"LATE",		"LATE2",
+	"PREEXEC",	"EXEC",		"SPECIFIC",
+	NULL
+} ;
+
+
+/* print a line about a single option */
+static int xiohelp_option(FILE *of, const struct optname *on, const char *name) {
+   int j;
+   unsigned int groups;
+   bool occurred;
+
+   fprintf(of, "      %s\tgroups=", name);
+   groups = on->desc->group;  occurred = false;
+   for (j = 0; j < 32; ++j) {
+      if (groups & 1) {
+	 if (occurred)  { fputc(',', of); }
+	 fprintf(of, "%s", addressgroupnames[j]);
+	 occurred = true;
+      }
+      groups >>= 1;
+   }
+   fprintf(of, "\tphase=%s", optionphasenames[on->desc->phase]);
+   fprintf(of, "\ttype=%s", optiontypenames[on->desc->type]);
+   fputc('\n', of);
+   return 0;
+}
+
+int xioopenhelp(FILE *of,
+	       int level	/* 0..only addresses, 1..and options */
+	       ) {
+   const struct addrname *an;
+   const struct optname *on;
+   int i, j;
+   unsigned int groups;
+   bool occurred;
+
+   fputs("   bi-address:\n", of);
+   fputs("      pipe[,<opts>]\tgroups=FD,FIFO\n", of);
+   if (level == 2) {
+      fputs("      echo is an alias for pipe\n", of);
+      fputs("      fifo is an alias for pipe\n", of);
+   }
+   fputs("      <single-address>!!<single-address>\n", of);
+   fputs("      <single-address>\n", of);
+   fputs("   single-address:\n", of);
+   fputs("      <address-head>[,<opts>]\n", of);
+   fputs("   address-head:\n", of);
+   an = &addressnames[0];
+   i = 0;
+   while (addressnames[i].name) {
+      if (!strcmp(an->name, an->desc->defname)) {
+         /* it is a canonical address name */
+	 fprintf(of, "      %s", an->name);
+	 if (an->desc->syntax) {
+	    fputs(an->desc->syntax, of); }
+	 fputs("\tgroups=", of);
+	 groups = an->desc->groups;  occurred = false;
+	 for (j = 0; j < 32; ++j) {
+	    if (groups & 1) {
+	       if (occurred) { fputc(',', of); }
+	       fprintf(of, "%s", addressgroupnames[j]);
+	       occurred = true;
+	    }
+	    groups >>= 1;
+	 }
+	 fputc('\n', of);
+      } else if (level == 2) {
+         fprintf(of, "         %s is an alias name for %s\n", an->name, an->desc->defname);
+      }
+      ++an; ++i;
+   }
+   if (level == 2) {
+      fputs("         <num> is a short form for fd:<num>\n", of);
+      fputs("         <filename> is a short form for gopen:<filename>\n", of);
+   }
+
+   if (level <= 0)  return 0;
+
+   fputs("   opts:\n", of);
+   fputs("      <opt>{,<opts>}:\n", of);
+   fputs("   opt:\n", of);
+   on = optionnames;
+   while (on->name != NULL) {
+      if (on->desc->nickname!= NULL
+	  && !strcmp(on->name, on->desc->nickname)) {
+	 if (level == 2) {
+	    fprintf(of, "      %s is an alias for %s\n", on->name, on->desc->defname);
+	 } else {
+	    xiohelp_option(of, on, on->name);
+	 }
+      } else if (on->desc->nickname == NULL &&
+		 !strcmp(on->name, on->desc->defname)) {
+	 xiohelp_option(of, on, on->name);
+      } else if (level == 2) {
+	 if (!strcmp(on->name, on->desc->defname)) {
+	    xiohelp_option(of, on, on->name);
+	 } else {
+	    fprintf(of, "      %s is an alias for %s\n", on->name, on->desc->defname);
+	 }
+      }
+      ++on;
+   }
+   fflush(of);
+   return 0;
+}
+
+#endif /* WITH_HELP */