Commit: 20ac96de8bb0591eabe630e7627c1427c387730d - mingw-org-wsl (git)

The MinGW.org Windows System Libraries

Commit MetaInfo

• Revisión: 20ac96de8bb0591eabe630e7627c1427c387730d (tree)
• Tiempo: 2016-03-27 05:54:49
• Autor: Keith Marshall <keithmarshall@user...>
• Commiter: Keith Marshall

Log Message

Factor out <direct.h> vs. <dos.h> duplicate declarations.

Cambiar Resumen

• modified: mingwrt/ChangeLog
• modified: mingwrt/include/direct.h
• modified: mingwrt/include/dos.h

Diferencia incremental

--- a/mingwrt/ChangeLog
+++ b/mingwrt/ChangeLog
@@ -1,5 +1,40 @@
 2016-03-26  Keith Marshall  <[e-mail]>
 
+	Factor out <direct.h> vs. <dos.h> duplicate declarations.
+
+	* include/dos.h: Assert copyright; tidy layout.
+	(pragma GCC system_header): Declare it.
+	(_DOS_H_): Rename multiple inclusion guard macro, to adopt...
+	(_DOS_H): ...this preferred convention; do not define it when...
+	[__DIRECT_H_SOURCED__]: ...this applies; restrict declarations to...
+	(struct _diskfree_t): ...this aggregate data type, together with...
+	[_NO_OLDNAMES] (diskfree_t): ...this alternative name for it, and...
+	(_getdiskfree): ...this associated function.
+	[!__DIRECT_H_SOURCED__] (_DOS_H): Define it; expose all content, but
+	emit a warning that this header is obsolete, and should not be used.
+	(_BEGIN_C_DECLS, _END_C_DECLS): Use to wrap extern "C" declarations.
+	(_DISKFREE_T_DEFINED): Do not define it; delete all references.
+	(__need_wchar_t): Do not define it; it isn't needed here, and hence,
+	neither is it necessary to #include <stddef.h>; do not do so.  Also,
+	do not #include <_mingw.h> explicitly, but always #include <io.h>,
+	which will implicitly #include <_mingw.h> anyway.
+
+	* include/direct.h: Assert copyright; tidy layout.
+	(pragma GCC system_header): Declare it.
+	(_DIRECT_H_): Rename this multiple inclusion guard macro...
+	(_DIRECT_H): ...to adopt this preferred naming convention.
+	(_BEGIN_C_DECLS, _END_C_DECLS): Use to wrap extern "C" declarations.
+	(_DISKFREE_T_DEFINED, diskfree_t, struct _diskfree_t): Do not define.
+	(_getdiskfree): Likewise, do not declare prototype; instead...
+	(__DIRECT_H_SOURCED__): ...define this, and #include <dos.h>; also
+	delegate indirect inclusion of <_mingw.h> and <io.h> to this, rather
+	than include them directly; undefine __DIRECT_H_SOURCED__ when done.
+	(__need_wchar_t): Do not define it, and do not #include <stddef.h>;
+	although needed, we may inherit it indirectly from <sys/types.h>,
+	included by <io.h> via <dos.h>.
+
[phone]  Keith Marshall  <[e-mail]>
+
 	Evade CPP mismatched apostrophe warnings in windres comments.
 
 	* msvcrt-xref/msvcrt.def.in (; pexports): 1,Gs/doesn't/does not/g

--- a/mingwrt/include/direct.h
+++ b/mingwrt/include/direct.h
@@ -1,73 +1,78 @@
 /*
  * direct.h
- * This file has no copyright assigned and is placed in the Public Domain.
- * This file is a part of the mingw-runtime package.
- * No warranty is given; refer to the file DISCLAIMER within the package.
  *
- * Functions for manipulating paths and directories (included from io.h)
- * plus functions for setting the current drive.
+ * Functions for manipulating paths and directories, (included from io.h),
+ * and functions for manipulating the current drive assignment.
+ *
+ * $Id$
+ *
+ * Written by Rob Savoye <[e-mail]>
+ * Copyright (C) 1997, 1999-2001, 2003, 2004, 2007, 2016, MinGW.org Project.
+ *
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice, this permission notice, and the following
+ * disclaimer shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF OR OTHER
+ * DEALINGS IN THE SOFTWARE.
  *
  */
-#ifndef	_DIRECT_H_
-#define	_DIRECT_H_
-
-/* All the headers include this file. */
-#include <_mingw.h>
+#ifndef _DIRECT_H
+#pragma GCC system_header
+#define _DIRECT_H
 
-#define __need_wchar_t
-#ifndef RC_INVOKED
-#include <stddef.h>
-#endif	/* Not RC_INVOKED */
-
-#include <io.h>
+#define __DIRECT_H_SOURCED__
+/* All MinGW headers are required to include <_mingw.h>; additionally,
+ * much of the content which we need here is defined in <io.h>, but we
+ * also need the declaration of the _getdiskfree() function prototype,
+ * and the definition for its associated _diskfree_t data structure,
+ * from <dos.h>; thus, we may simply include <dos.h> here, and let
+ * it take care of including both <mingw.h> and <io.h> for us.
+ */
+#include <dos.h>
 
+#undef __DIRECT_H_SOURCED__
 #ifndef RC_INVOKED
 
-#ifdef	__cplusplus
-extern "C" {
-#endif
+_BEGIN_C_DECLS
 
-#ifndef _DISKFREE_T_DEFINED
-/* needed by _getdiskfree (also in dos.h) */
-struct _diskfree_t {
-	unsigned total_clusters;
-	unsigned avail_clusters;
-	unsigned sectors_per_cluster;
-	unsigned bytes_per_sector;
-};
-#define _DISKFREE_T_DEFINED
-#endif
+/* Functions for manipulating disk drive selection.
+ */
+_CRTIMP __cdecl __MINGW_NOTHROW  int _getdrive (void);
+_CRTIMP __cdecl __MINGW_NOTHROW  unsigned long _getdrives(void);
+_CRTIMP __cdecl __MINGW_NOTHROW  int _chdrive (int);
+_CRTIMP __cdecl __MINGW_NOTHROW  char *_getdcwd (int, char*, int);
 
-/*
- * You really shouldn't be using these. Use the Win32 API functions instead.
- * However, it does make it easier to port older code.
+/* The following group of functions  are available only within
+ * MSVCRT.DLL, (i.e. they are NOT provided by CRTDLL.DLL); they
+ * are also declared in <wchar.h>, hence avoid declaring them a
+ * second time.
  */
-_CRTIMP int __cdecl __MINGW_NOTHROW _getdrive (void);
-_CRTIMP unsigned long __cdecl __MINGW_NOTHROW _getdrives(void);
-_CRTIMP int __cdecl __MINGW_NOTHROW _chdrive (int);
-_CRTIMP char* __cdecl __MINGW_NOTHROW _getdcwd (int, char*, int);
-_CRTIMP unsigned __cdecl __MINGW_NOTHROW _getdiskfree (unsigned, struct _diskfree_t *);
+#if defined __MSVCRT__ && ! defined _WDIRECT_DEFINED
 
-#ifndef	_NO_OLDNAMES
-# define diskfree_t _diskfree_t
-#endif
+_CRTIMP __cdecl __MINGW_NOTHROW  int _wchdir (const wchar_t *);
+_CRTIMP __cdecl __MINGW_NOTHROW  wchar_t *_wgetcwd (wchar_t *, int);
+_CRTIMP __cdecl __MINGW_NOTHROW  wchar_t *_wgetdcwd (int, wchar_t *, int);
+_CRTIMP __cdecl __MINGW_NOTHROW  int _wmkdir (const wchar_t *);
+_CRTIMP __cdecl __MINGW_NOTHROW  int _wrmdir (const wchar_t *);
 
-#ifndef _WDIRECT_DEFINED
-/* wide character versions. Also in wchar.h */
-#ifdef __MSVCRT__
-_CRTIMP int __cdecl __MINGW_NOTHROW _wchdir(const wchar_t*);
-_CRTIMP wchar_t* __cdecl __MINGW_NOTHROW _wgetcwd(wchar_t*, int);
-_CRTIMP wchar_t* __cdecl __MINGW_NOTHROW _wgetdcwd(int, wchar_t*, int);
-_CRTIMP int __cdecl __MINGW_NOTHROW _wmkdir(const wchar_t*);
-_CRTIMP int __cdecl __MINGW_NOTHROW _wrmdir(const wchar_t*);
-#endif	/* __MSVCRT__ */
 #define _WDIRECT_DEFINED
-#endif
-
-#ifdef	__cplusplus
-}
-#endif
+#endif	/* __MSVCRT__ && !_WDIRECT_DEFINED */
 
-#endif	/* Not RC_INVOKED */
+_END_C_DECLS
 
-#endif	/* Not _DIRECT_H_ */
+#endif	/* ! RC_INVOKED */
+#endif  /* !_DIRECT_H: $RCSfile$: end of file */

--- a/mingwrt/include/dos.h
+++ b/mingwrt/include/dos.h
@@ -1,35 +1,78 @@
 /*
  * dos.h
- * This file has no copyright assigned and is placed in the Public Domain.
- * This file is a part of the mingw-runtime package.
- * No warranty is given; refer to the file DISCLAIMER within the package.
  *
- * DOS-specific functions and structures.
+ * Functions and structures inherited from MS-DOS.
+ *
+ * $Id$
+ *
+ * Written by Jan-Jaap van der Heijden
+ * Copyright (C) 1997-1999, 2001-2004, 2007, 2016, MinGW.org Project.
+ *
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice, this permission notice, and the following
+ * disclaimer shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF OR OTHER
+ * DEALINGS IN THE SOFTWARE.
  *
  */
-
-#ifndef	_DOS_H_
-#define	_DOS_H_
-
-/* All the headers include this file. */
-#include <_mingw.h>
-
-#define __need_wchar_t
-#ifndef RC_INVOKED
-#include <stddef.h>
-#endif	/* Not RC_INVOKED */
-
-/* For DOS file attributes */
+#ifndef	_DOS_H
+#pragma GCC system_header
+
+/* This header supports selective inclusion by <direct.h>, for delegated
+ * access to the content of <io.h>, and for declaration of the prototype
+ * and associated data structure for the _getdiskfree() function; since
+ * including <dos.h> in this manner does not make all of its content
+ * visible, we defer definition of its multiple inclusion guard...
+ */
+#ifndef __DIRECT_H_SOURCED__
+ /* ...until we have determined that this inclusion is NOT a selective
+  * request from <direct.h>; in spite of it being obsolete, it appears
+  * that the user may have included <dos.h> directly.
+  */
+#define	_DOS_H
+#warning "<dos.h> is obsolete; consider using <direct.h> instead."
+#endif	/* !__DIRECT_H_SOURCED__ */
+
+/* All MinGW headers are required to include <_mingw.h>; additionally,
+ * for DOS file attributes, we must include <io.h>.  By unconditionally
+ * including <io.h> here, we may delegate the inclusion of <_mingw.h> to
+ * it, while also allowing <direct.h> to delegate responsibility for the
+ * inclusion of both <_mingw.h> and <io.h> to us.
+ */
 #include <io.h>
 
 #ifndef RC_INVOKED
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+_BEGIN_C_DECLS
 
-#ifndef __MSVCRT__ /* these are in CRTDLL, but not MSVCRT */
+/* The following declarations are to be visible ONLY when <dos.h>
+ * is included in its own right; they represent entities which are
+ * present in CRTDLL.DLL, but not in MSVCRT.DLL
+ */
+#if defined _DOS_H && ! defined __MSVCRT__
 #ifndef __DECLSPEC_SUPPORTED
+
+# define _basemajor    (*_imp___basemajor_dll)
+# define _baseminor    (*_imp___baseminor_dll)
+# define _baseversion  (*_imp___baseversion_dll)
+# define _osmajor      (*_imp___osmajor_dll)
+# define _osminor      (*_imp___osminor_dll)
+# define _osmode       (*_imp___osmode_dll)
+
 extern unsigned int *_imp___basemajor_dll;
 extern unsigned int *_imp___baseminor_dll;
 extern unsigned int *_imp___baseversion_dll;
@@ -37,15 +80,15 @@ extern unsigned int *_imp___osmajor_dll;
 extern unsigned int *_imp___osminor_dll;
 extern unsigned int *_imp___osmode_dll;
 
-#define _basemajor (*_imp___basemajor_dll)
-#define _baseminor (*_imp___baseminor_dll)
-#define _baseversion (*_imp___baseversion_dll)
-#define _osmajor (*_imp___osmajor_dll)
-#define _osminor (*_imp___osminor_dll)
-#define _osmode (*_imp___osmode_dll)
-
 #else /* __DECLSPEC_SUPPORTED */
 
+# define _basemajor    _basemajor_dll
+# define _baseminor    _baseminor_dll
+# define _baseversion  _baseversion_dll
+# define _osmajor      _osmajor_dll
+# define _osminor      _osminor_dll
+# define _osmode       _osmode_dll
+
 __MINGW_IMPORT unsigned int _basemajor_dll;
 __MINGW_IMPORT unsigned int _baseminor_dll;
 __MINGW_IMPORT unsigned int _baseversion_dll;
@@ -53,37 +96,41 @@ __MINGW_IMPORT unsigned int _osmajor_dll;
 __MINGW_IMPORT unsigned int _osminor_dll;
 __MINGW_IMPORT unsigned int _osmode_dll;
 
-#define _basemajor _basemajor_dll
-#define _baseminor _baseminor_dll
-#define _baseversion _baseversion_dll
-#define _osmajor _osmajor_dll
-#define _osminor _osminor_dll
-#define _osmode _osmode_dll
-
-#endif /* __DECLSPEC_SUPPORTED */
-#endif /* ! __MSVCRT__ */
-
-#ifndef _DISKFREE_T_DEFINED
-/* needed by _getdiskfree (also in direct.h) */
-struct _diskfree_t {
-	unsigned total_clusters;
-	unsigned avail_clusters;
-	unsigned sectors_per_cluster;
-	unsigned bytes_per_sector;
-};
-#define _DISKFREE_T_DEFINED
-#endif
-
-_CRTIMP unsigned __cdecl __MINGW_NOTHROW _getdiskfree (unsigned, struct _diskfree_t *);
+#endif	/* __DECLSPEC_SUPPORTED */
+#endif	/* _DOS_H && !__MSVCRT__ */
 
+/* The following section, which declares the _getdiskfree() function
+ * prototype, and also defines its associated _diskfree_t data structure,
+ * is to be processed both when including <dos.h> in its own right, and
+ * when selectively included by <direct.h>; however...
+ */
+#if ! (defined _DOS_H && defined _DIRECT_H)
+ /* ...when both the _DOS_H guard, and the _DIRECT_H multiple inclusion
+  * guards have been defined, by the time we get to here, then this is
+  * <dos.h> inclusion in its own right, and we have ALREADY processed
+  * these definitions through selective inclusion by <direct.h>; we
+  * MUST NOT process them a second time.
+  */
 #ifndef	_NO_OLDNAMES
-# define diskfree_t _diskfree_t
+# define diskfree_t  _diskfree_t
 #endif
 
-#ifdef __cplusplus
-}
-#endif
+struct _diskfree_t
+{ /* A structure in which to store information about disk
+   * free space, as returned by the _getdiskfree() function.
+   */
+  unsigned total_clusters;
+  unsigned avail_clusters;
+  unsigned sectors_per_cluster;
+  unsigned bytes_per_sector;
+};
+
+_CRTIMP __cdecl __MINGW_NOTHROW
+unsigned _getdiskfree (unsigned, struct _diskfree_t *);
+
+#endif	/* ! ( _DOS_H && _DIRECT_H) */
 
-#endif	/* Not RC_INVOKED */
+_END_C_DECLS
 
-#endif	/* Not _DOS_H_ */
+#endif	/* ! RC_INVOKED */
+#endif  /* !_DOS_H: $RCSfile$: end of file */