kernel: remove some redundant #includes (#5885)

... and add comments to a few others to explain why they
are needed

src/bits_intern.h

@@ -13,7 +13,7 @@
 
 #include "system.h"
 
-#include <string.h>
+#include <string.h>     // for memcpy
 
 
 #define ALL_BITS_UINT  (~(UInt)0)

src/debug.c

@@ -30,12 +30,11 @@
 
 #include "config.h"
 
-#include <stdio.h>
-#include <stdlib.h>
-
 #if defined(HAVE_BACKTRACE) && defined(GAP_PRINT_BACKTRACE)
 #include <execinfo.h>
 #include <signal.h>
+#include <stdio.h>      // for fprintf, fileno
+#include <stdlib.h>     // for exit
 
 static void BacktraceHandler(int sig) NORETURN;
 

src/error.c

@@ -36,7 +36,7 @@
 #include "hpc/thread.h"
 #endif
 
-#include <stdio.h>
+#include <stdio.h>  // for fprintf
 
 
 static Obj ErrorInner;

src/funcs.c

@@ -37,10 +37,9 @@
 #ifdef HPCGAP
 #include "hpc/guards.h"
 #include "hpc/thread.h"
+#include <stdlib.h>     // for alloca
 #endif
 
-#include <stdlib.h>
-
 
 static ModuleStateOffset FuncsStateOffset = -1;
 

src/gvars.c

@@ -46,11 +46,8 @@
 #include "hpc/aobjects.h"
 #include "hpc/guards.h"
 #include "hpc/thread.h"
-#include <pthread.h>
 #endif
 
-#include <stdio.h>
-
 
 #ifdef HPCGAP
 #define USE_GVAR_BUCKETS
@@ -59,6 +56,8 @@
 
 #ifdef USE_GVAR_BUCKETS
 
+#include <stdio.h>      // for sprintf
+
 #define GVAR_BUCKETS 1024
 #define GVAR_BUCKET_SIZE 1024
 

src/hookintrprtr.c

@@ -21,7 +21,7 @@
 
 #include "hpc/thread.h"
 
-#include <string.h>
+#include <string.h>     // for memcpy
 
 
 // List of active hooks

src/hpc/aobjects.c

@@ -32,7 +32,7 @@
 #include "records.h"
 #include "stringobj.h"
 
-#include <stdlib.h>
+#include <stdlib.h>     // for labs
 
 
 static Obj TYPE_ALIST;

src/macfloat.c

@@ -35,8 +35,8 @@
 
 #include "config.h"
 
-#include <stdio.h>
-#include <stdlib.h>
+#include <stdio.h>      // for snprintf
+#include <stdlib.h>     // for strtod
 
 
 #define RequireMacFloat(funcname, op) \

src/main.c

@@ -20,9 +20,9 @@
 
 #include "config.h"
 
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
+#include <stdlib.h>     // for getenv, realpath, ...
+#include <string.h>     // for snprintf
+#include <unistd.h>     // for access, readlink, ...
 
 #if defined(__APPLE__) && defined(__MACH__)
 // Workaround: TRUE / FALSE are also defined by the macOS Mach-O headers

src/modules.c

@@ -44,7 +44,7 @@
 #include <dlfcn.h>
 #endif
 
-#include <stdio.h>
+#include <stdio.h>      // for fprintf, stderr
 
 
 /****************************************************************************

src/objects.c

@@ -32,16 +32,14 @@
 #include "hpc/guards.h"
 #include "hpc/thread.h"
 #include "hpc/traverse.h"
+#include <stdio.h>      // for sprintf
+#include <stdlib.h>     // for getenv
 #endif
 
 #if defined(USE_THREADSAFE_COPYING)
 #include "hpc/traverse.h"
 #endif
 
-#include <stdio.h>
-#include <stdlib.h>
-
-
 enum {
     MAXPRINTDEPTH = 64,
 };

src/opers.cc

@@ -46,8 +46,6 @@ extern "C" {
 #include <pthread.h>
 #endif
 
-#include <stdio.h>
-
 #include "config.h"
 
 } // extern "C"

src/plist.h

@@ -28,7 +28,7 @@
 
 #include "objects.h"
 
-#include <string.h>
+#include <string.h>  // for memcpy
 
 /****************************************************************************
 **

src/precord.c

@@ -47,7 +47,7 @@
 #include "hpc/traverse.h"
 #endif
 
-#include <stdlib.h>
+#include <stdlib.h>     // for qsort
 
 /****************************************************************************
 **

src/profile.c

@@ -34,10 +34,10 @@
 
 #include "config.h"
 
-#include <stdio.h>
+#include <stdio.h>                      // for fprintf, fflush, popen, pclose, fopen, fclose
 #include <sys/time.h>                   // for gettimeofday
-#include <sys/types.h>
-#include <unistd.h>
+#include <sys/types.h>                  // for pid_t
+#include <unistd.h>                     // for getpid
 #ifdef HAVE_SYS_RESOURCE_H
 #include <sys/resource.h>               // definition of 'struct rusage'
 #endif

src/stringobj.h

@@ -24,7 +24,7 @@
 
 #include "objects.h"
 
-#include <string.h>
+#include <string.h>     // for memcpy
 
 
 /****************************************************************************

src/symbols.c

@@ -20,8 +20,6 @@
 #include "hpc/thread.h"
 #endif
 
-#include <stdlib.h>
-
 
 void InitSymbolTableKernel(SymbolTable *      symtab,
                            const char *       cookieCount,

src/symbols.h

@@ -14,7 +14,7 @@
 #include "common.h"
 
 #ifdef HPCGAP
-#include <pthread.h>
+#include <pthread.h>    // for pthread_rwlock_t
 #endif
 
 // some auxiliary typedefs for SymbolTable

src/sysfiles.c

@@ -31,7 +31,6 @@
 #include "records.h"
 #include "stats.h"
 #include "stringobj.h"
-#include "sysenv.h"
 #include "sysopt.h"
 #include "sysstr.h"
 #include "system.h"

src/sysmem.c

@@ -23,19 +23,21 @@
 
 #ifdef GAP_MEM_CHECK
 #include <fcntl.h>
+#include <stdlib.h>     // for qsort
+#include <unistd.h>     // for ftruncate, getpid, unlink
 #endif
 
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
+#include <stdio.h>      // for fputs
 
 #ifdef HAVE_MADVISE
 #include <sys/mman.h>
 #endif
 
 #ifdef HAVE_VM_ALLOCATE
 #include <mach/mach.h>
+#elif defined(HAVE_SBRK)
+#include <string.h>     // for memset
+#include <unistd.h>     // for sbrk
 #endif
 
 

src/trans.cc

@@ -64,7 +64,7 @@ extern "C" {
 #include "plist.h"
 #include "saveload.h"
 
-#include <stdio.h>
+#include <stdio.h>      // for snprintf
 
 } // extern "C"
 

src/trycatch.c

@@ -13,8 +13,6 @@
 
 #include "gaputils.h"
 
-#include <stdio.h>
-
 static ThrowObserver throwObservers[16];
 
 int RegisterThrowObserver(ThrowObserver func)

src/vars.c

@@ -43,7 +43,7 @@
 #include "hpc/guards.h"
 #endif
 
-#include <stdio.h>
+#include <stdio.h>      // for snprintf
 
 
 /****************************************************************************