Discussion:
getopt link error on MSVC
(too old to reply)
Bruno Haible
2016-12-18 12:09:28 UTC
Permalink
Raw Message
I see the following test link failure on MSVC, from a use of the 'getopt-posix'
module:

/home/bruno/msvc/compile cl -nologo -DHAVE_CONFIG_H -DEXEEXT=\".exe\" -I. -I../../gltests -I.. -DGNULIB_STRICT_CHECKING=1 -DIN_GNULIB_TESTS=1 -I. -I../../gltests -I.. -I../../gltests/.. -I../gllib -I../../gltests/../gllib -D_WIN32_WINNT=_WIN32_WINNT_WINXP -I/usr/local/msvc32/include -MD -c -o test-getopt.obj `cygpath -w '../../gltests/test-getopt.c'`
test-getopt.c
/home/bruno/msvc/compile cl -nologo -MD -L/usr/local/msvc32/lib -o test-getopt.exe test-getopt.obj libtests.a ../gllib/libgnu.a libtests.a
test-getopt.obj : error LNK2001: unresolved external symbol _getopt
test-getopt.obj : error LNK2019: unresolved external symbol _optarg referenced in function _getopt_loop
test-getopt.obj : error LNK2019: unresolved external symbol _optind referenced in function _test_getopt
test-getopt.obj : error LNK2019: unresolved external symbol _opterr referenced in function _test_getopt
test-getopt.obj : error LNK2019: unresolved external symbol _optopt referenced in function _getopt_loop
test-getopt.exe : fatal error LNK1120: 5 unresolved externals
make[4]: *** [Makefile:6287: test-getopt.exe] Error 2

This compilation error goes away if test-getopt.c is changed to include
<getopt.h> instead of <unistd.h>. Nevertheless, it should also work with
<unistd.h>, since that's the header according to POSIX and the glibc doc:
http://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html
https://www.gnu.org/software/libc/manual/html_node/Using-Getopt.html

Currently, the compiled getopt.obj defines the symbols 'rpl_getopt', 'rpl_optarg'
etc. But when #include <unistd.h> is used, the compiled test-getopt.obj
requests the symbols 'getopt', 'optarg', etc.

This fixes it. Reminder for the reviewer:
- "#if defined __GETOPT_PREFIX" is true if this code in used in gnulib, whereas
it's false inside glibc.
- "#if defined __need_getopt" is true if this code is being included from <unistd.h>.
<unistd.h> wants only the declarations mentioned in
http://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html


2016-12-18 Bruno Haible <***@clisp.org>

getopt: Fix link error for users of getopt() in <unistd.h>.
* lib/getopt.in.h (getopt etc.): Do the macro definitions also when
__need_getopt is defined. Undefine all macros before defining them.
* modules/getopt (Include): Clarify that including <unistd.h> is also
OK.
* tests/test-getopt.c: Add comment.

diff --git a/lib/getopt.in.h b/lib/getopt.in.h
index 0f72182..64469b7 100644
--- a/lib/getopt.in.h
+++ b/lib/getopt.in.h
@@ -47,15 +47,20 @@
identifiers so that they do not collide with the system functions
and variables. Renaming avoids problems with some compilers and
linkers. */
-#if defined __GETOPT_PREFIX && !defined __need_getopt
-# if !@HAVE_GETOPT_H@
-# define __need_system_stdlib_h
-# include <stdlib.h>
-# undef __need_system_stdlib_h
-# include <stdio.h>
-# include <unistd.h>
+#if defined __GETOPT_PREFIX
+# if !defined __need_getopt
+# if !@HAVE_GETOPT_H@
+# define __need_system_stdlib_h
+# include <stdlib.h>
+# undef __need_system_stdlib_h
+# include <stdio.h>
+# include <unistd.h>
+# endif
+# undef __need_getopt
# endif
-# undef __need_getopt
+# undef __GETOPT_CONCAT
+# undef __GETOPT_XCONCAT
+# undef __GETOPT_ID
# undef getopt
# undef getopt_long
# undef getopt_long_only
@@ -64,6 +69,7 @@
# undef optind
# undef optopt
# undef option
+# undef _getopt_internal
# define __GETOPT_CONCAT(x, y) x ## y
# define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
# define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
diff --git a/modules/getopt b/modules/getopt
index 5d4f3c4..53c844d 100644
--- a/modules/getopt
+++ b/modules/getopt
@@ -17,7 +17,7 @@ configure.ac:
Makefile.am:

Include:
-<getopt.h>
+<getopt.h> or <unistd.h>

License:
LGPL
diff --git a/tests/test-getopt.c b/tests/test-getopt.c
index 505cb2a..04e1ae6 100644
--- a/tests/test-getopt.c
+++ b/tests/test-getopt.c
@@ -38,7 +38,17 @@ SIGNATURE_CHECK (getopt_long_only, int, (int, char *__getopt_argv_const *,

#endif

-#include <unistd.h>
+/* POSIX and glibc provide the getopt() function in <unistd.h>, see
+ http://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html
+ https://www.gnu.org/software/libc/manual/html_node/Using-Getopt.html
+ But gnulib provides the getopt() function in <getopt.h>, not in <unistd.h>.
+ Nevertheless the getopt() function should also be found in <unistd.h>.
+ We can test it either way. */
+#if 0
+# include <getopt.h>
+#else
+# include <unistd.h>
+#endif

#include "signature.h"
SIGNATURE_CHECK (getopt, int, (int, char * const[], char const *));
Bruno Haible
2016-12-18 13:05:52 UTC
Permalink
Raw Message
Post by Bruno Haible
+/* POSIX and glibc provide the getopt() function in <unistd.h>, see
+ http://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html
+ https://www.gnu.org/software/libc/manual/html_node/Using-Getopt.html
+ But gnulib provides the getopt() function in <getopt.h>, not in <unistd.h>.
+ Nevertheless the getopt() function should also be found in <unistd.h>.
+ We can test it either way. */
+#if 0
+# include <getopt.h>
+#else
+# include <unistd.h>
+#endif
A test that checks only one of <getopt.h> and <unistd.h> checks only half of
the requirements. It's better to check both <getopt.h> and <unistd.h>. Done
through the following patch:


2016-12-18 Bruno Haible <***@clisp.org>

Split tests for getopt-posix and getopt-gnu.
* tests/test-getopt-posix.c: New file.
* tests/test-getopt-gnu.c: New file, with code from test-getopt.c.
* tests/test-getopt-main.h: Renamed from tests/test-getopt.c. Remove
stuff moved to test-getopt-gnu.c. Test TEST_GETOPT_GNU instead of
GNULIB_TEST_GETOPT_GNU.
* modules/getopt-posix-tests (Files): Add test-getopt-posix.c,
test-getopt-main.h. Remove test-getopt.c, test-getopt_long.h.
(Makefile.am): Test test-getopt-posix instead of test-getopt.
* modules/getopt-gnu-tests: New file.
* modules/getopt-gnu (configure.ac): Don't define GNULIB_TEST_GETOPT_GNU.

diff --git a/modules/getopt-gnu b/modules/getopt-gnu
index 69fc7de..606013b 100644
--- a/modules/getopt-gnu
+++ b/modules/getopt-gnu
@@ -18,7 +18,6 @@ if test $REPLACE_GETOPT = 1; then
GNULIB_${gl_include_guard_prefix}_UNISTD_H_GETOPT=1
fi
AC_SUBST([GNULIB_${gl_include_guard_prefix}_UNISTD_H_GETOPT])
-gl_MODULE_INDICATOR_FOR_TESTS([getopt-gnu])

Makefile.am:

diff --git a/modules/getopt-gnu-tests b/modules/getopt-gnu-tests
new file mode 100644
index 0000000..688b5de
--- /dev/null
+++ b/modules/getopt-gnu-tests
@@ -0,0 +1,21 @@
+Files:
+tests/macros.h
+tests/signature.h
+tests/test-getopt-gnu.c
+tests/test-getopt-main.h
+tests/test-getopt.h
+tests/test-getopt_long.h
+
+Depends-on:
+dup2
+setenv
+stdbool
+unistd
+unsetenv
+
+configure.ac:
+
+Makefile.am:
+TESTS += test-getopt-gnu
+check_PROGRAMS += test-getopt-gnu
+test_getopt_gnu_LDADD = $(LDADD) $(LIBINTL)
diff --git a/modules/getopt-posix-tests b/modules/getopt-posix-tests
index 9c73d08..067e38f 100644
--- a/modules/getopt-posix-tests
+++ b/modules/getopt-posix-tests
@@ -1,9 +1,9 @@
Files:
tests/macros.h
tests/signature.h
-tests/test-getopt.c
+tests/test-getopt-posix.c
+tests/test-getopt-main.h
tests/test-getopt.h
-tests/test-getopt_long.h

Depends-on:
dup2
@@ -15,6 +15,6 @@ unsetenv
configure.ac:

Makefile.am:
-TESTS += test-getopt
-check_PROGRAMS += test-getopt
-test_getopt_LDADD = $(LDADD) $(LIBINTL)
+TESTS += test-getopt-posix
+check_PROGRAMS += test-getopt-posix
+test_getopt_posixLDADD = $(LDADD) $(LIBINTL)
diff --git a/tests/test-getopt-gnu.c b/tests/test-getopt-gnu.c
new file mode 100644
index 0000000..eb0a166
--- /dev/null
+++ b/tests/test-getopt-gnu.c
@@ -0,0 +1,44 @@
+/* Test of command line argument processing.
+ Copyright (C) 2009-2016 Free Software Foundation, Inc.
+
+ This program 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 3 of the License, or
+ (at your option) any later version.
+
+ This program 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 this program. If not, see <http://www.gnu.org/licenses/>. */
+
+/* Written by Bruno Haible <***@clisp.org>, 2009. */
+
+#include <config.h>
+
+/* None of the files accessed by this test are large, so disable the
+ ftell link warning if we are not using the gnulib ftell module. */
+#define _GL_NO_LARGE_FILES
+
+/* POSIX and glibc provide the getopt() function in <unistd.h>, see
+ http://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html
+ https://www.gnu.org/software/libc/manual/html_node/Using-Getopt.html
+ But gnulib provides the getopt() function in <getopt.h>, not in <unistd.h>.
+ This is what we are testing here. */
+#include <getopt.h>
+
+#ifndef __getopt_argv_const
+# define __getopt_argv_const const
+#endif
+#include "signature.h"
+SIGNATURE_CHECK (getopt_long, int, (int, char *__getopt_argv_const *,
+ char const *, struct option const *,
+ int *));
+SIGNATURE_CHECK (getopt_long_only, int, (int, char *__getopt_argv_const *,
+ char const *, struct option const *,
+ int *));
+
+#define TEST_GETOPT_GNU 1
+#include "test-getopt-main.h"
diff --git a/tests/test-getopt-main.h b/tests/test-getopt-main.h
new file mode 100644
index 0000000..2c9fa49
--- /dev/null
+++ b/tests/test-getopt-main.h
@@ -0,0 +1,76 @@
+/* Test of command line argument processing.
+ Copyright (C) 2009-2016 Free Software Foundation, Inc.
+
+ This program 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 3 of the License, or
+ (at your option) any later version.
+
+ This program 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 this program. If not, see <http://www.gnu.org/licenses/>. */
+
+/* Written by Bruno Haible <***@clisp.org>, 2009. */
+
+#include "signature.h"
+SIGNATURE_CHECK (getopt, int, (int, char * const[], char const *));
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+/* This test intentionally remaps stderr. So, we arrange to have fd 10
+ (outside the range of interesting fd's during the test) set up to
+ duplicate the original stderr. */
+
+#define BACKUP_STDERR_FILENO 10
+#define ASSERT_STREAM myerr
+#include "macros.h"
+
+static FILE *myerr;
+
+#include "test-getopt.h"
+#if TEST_GETOPT_GNU
+# include "test-getopt_long.h"
+#endif
+
+int
+main (void)
+{
+ /* This test validates that stderr is used correctly, so move the
+ original into fd 10. */
+ if (dup2 (STDERR_FILENO, BACKUP_STDERR_FILENO) != BACKUP_STDERR_FILENO
+ || (myerr = fdopen (BACKUP_STDERR_FILENO, "w")) == NULL)
+ return 2;
+
+ ASSERT (freopen ("test-getopt.tmp", "w", stderr) == stderr);
+
+ /* These default values are required by POSIX. */
+ ASSERT (optind == 1);
+ ASSERT (opterr != 0);
+
+ setenv ("POSIXLY_CORRECT", "1", 1);
+ test_getopt ();
+
+#if TEST_GETOPT_GNU
+ test_getopt_long_posix ();
+#endif
+
+ unsetenv ("POSIXLY_CORRECT");
+ test_getopt ();
+
+#if TEST_GETOPT_GNU
+ test_getopt_long ();
+ test_getopt_long_only ();
+#endif
+
+ ASSERT (fclose (stderr) == 0);
+ ASSERT (remove ("test-getopt.tmp") == 0);
+
+ return 0;
+}
diff --git a/tests/test-getopt-posix.c b/tests/test-getopt-posix.c
new file mode 100644
index 0000000..c89981f
--- /dev/null
+++ b/tests/test-getopt-posix.c
@@ -0,0 +1,33 @@
+/* Test of command line argument processing.
+ Copyright (C) 2009-2016 Free Software Foundation, Inc.
+
+ This program 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 3 of the License, or
+ (at your option) any later version.
+
+ This program 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 this program. If not, see <http://www.gnu.org/licenses/>. */
+
+/* Written by Bruno Haible <***@clisp.org>, 2009. */
+
+#include <config.h>
+
+/* None of the files accessed by this test are large, so disable the
+ ftell link warning if we are not using the gnulib ftell module. */
+#define _GL_NO_LARGE_FILES
+
+/* POSIX and glibc provide the getopt() function in <unistd.h>, see
+ http://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html
+ https://www.gnu.org/software/libc/manual/html_node/Using-Getopt.html
+ But gnulib provides the getopt() function in <getopt.h>, not in <unistd.h>.
+ Nevertheless the getopt() function should also be found in <unistd.h>. */
+#include <unistd.h>
+
+#define TEST_GETOPT_GNU 0
+#include "test-getopt-main.h"

Loading...