build(IWYU): replace public-to-public mappings with pragmas (#26237)

cmake.config/iwyu/mapping.imp

@@ -175,10 +175,6 @@
   { include: [ '"ex_cmds_enum.generated.h"', private, '"nvim/ex_cmds_defs.h"', public ] },
   { include: [ '"keysets.h.generated.h"', private, '"nvim/api/private/helpers.h"', public ] },
   { include: [ '"keysets_defs.generated.h"', private, '"nvim/api/private/defs.h"', public ] },
-  { include: [ '"nvim/os/pty_process_unix.h"', private, '"nvim/os/pty_process.h"', public ] },
-  { include: [ '"nvim/os/pty_process_win.h"', private, '"nvim/os/pty_process.h"', public ] },
-  { include: [ '"nvim/os/unix_defs.h"', private, '"nvim/os/os_defs.h"', public ] },
-  { include: [ '"nvim/os/win_defs.h"', private, '"nvim/os/os_defs.h"', public ] },
   { include: [ '"os/env.h.generated.h"', private, '"nvim/os/os.h"', public ] },
   { include: [ '"os/fs.h.generated.h"', private, '"nvim/os/os.h"', public ] },
   { include: [ '"os/mem.h.generated.h"', private, '"nvim/os/os.h"', public ] },
@@ -189,55 +185,14 @@
   { include: [ '"ui_events_remote.generated.h"', private, '"nvim/api/ui.h"', public ] },
   { include: [ '"ui_events_remote.h.generated.h"', private, '"nvim/api/ui.h"', public ] },
 
-  # Def to normal headers: nvim/header_defs.h -> nvim/header.h
-  #
-  # This is a public to public mapping, meaning that while IWYU can use the
-  # headers on the left, it will use the headers on the right if possible. This
-  # isn't explicitly mentioned in the IWYU docs, this is just my interpretation
-  # of its behavior.
-  { include: [ '"nvim/arglist_defs.h"', public, '"nvim/arglist.h"', public ] },
-  { include: [ '"nvim/buffer_defs.h"', public, '"nvim/buffer.h"', public ] },
-  { include: [ '"nvim/cmdexpand_defs.h"', public, '"nvim/cmdexpand.h"', public ] },
-  { include: [ '"nvim/decoration_defs.h"', public, '"nvim/decoration.h"', public ] },
-  { include: [ '"nvim/eval/typval_defs.h"', public, '"nvim/eval/typval.h"', public ] },
-  { include: [ '"nvim/ex_cmds_defs.h"', public, '"nvim/ex_cmds.h"', public ] },
-  { include: [ '"nvim/ex_eval_defs.h"', public, '"nvim/ex_eval.h"', public ] },
-  { include: [ '"nvim/extmark_defs.h"', public, '"nvim/extmark.h"', public ] },
-  { include: [ '"nvim/fold_defs.h"', public, '"nvim/fold.h"', public ] },
-  { include: [ '"nvim/garray_defs.h"', public, '"nvim/garray.h"', public ] },
-  { include: [ '"nvim/getchar_defs.h"', public, '"nvim/getchar.h"', public ] },
-  { include: [ '"nvim/grid_defs.h"', public, '"nvim/grid.h"', public ] },
-  { include: [ '"nvim/highlight_defs.h"', public, '"nvim/highlight.h"', public ] },
-  { include: [ '"nvim/mapping_defs.h"', public, '"nvim/mapping.h"', public ] },
-  { include: [ '"nvim/mark_defs.h"', public, '"nvim/mark.h"', public ] },
-  { include: [ '"nvim/mbyte_defs.h"', public, '"nvim/mbyte.h"', public ] },
-  { include: [ '"nvim/memfile_defs.h"', public, '"nvim/memfile.h"', public ] },
-  { include: [ '"nvim/memline_defs.h"', public, '"nvim/memline.h"', public ] },
-  { include: [ '"nvim/menu_defs.h"', public, '"nvim/menu.h"', public ] },
-  { include: [ '"nvim/msgpack/channel_defs.h"', public, '"nvim/msgpack/channel.h"', public ] },
-  { include: [ '"nvim/option_defs.h"', public, '"nvim/option.h"', public ] },
-  { include: [ '"nvim/os/fs_defs.h"', public, '"nvim/os/fs.h"', public ] },
-  { include: [ '"nvim/os/os_defs.h"', public, '"nvim/os/os.h"', public ] },
-  { include: [ '"nvim/regexp_defs.h"', public, '"nvim/regexp.h"', public ] },
-  { include: [ '"nvim/sign_defs.h"', public, '"nvim/sign.h"', public ] },
-  { include: [ '"nvim/spell_defs.h"', public, '"nvim/spell.h"', public ] },
-  { include: [ '"nvim/statusline_defs.h"', public, '"nvim/statusline.h"', public ] },
-  { include: [ '"nvim/syntax_defs.h"', public, '"nvim/syntax.h"', public ] },
-  { include: [ '"nvim/tui/input_defs.h"', public, '"nvim/tui/input.h"', public ] },
-  { include: [ '"nvim/undo_defs.h"', public, '"nvim/undo.h"', public ] },
-
   # Symbols
   { symbol: [ "MAX", private, '"nvim/macros.h"', public ] },
   { symbol: [ "MIN", private, '"nvim/macros.h"', public ] },
 
   # Third party headers
-  { include: [ '<libintl.h>', public, '"nvim/gettext.h"', public ] },
   { include: [ '<netdb.h>', public, '"nvim/os/unix_defs.h"', private ] },
   { include: [ '<netinet/in.h>', public, '"nvim/os/unix_defs.h"', private ] },
   { include: [ '<pthread.h>', public, '"nvim/os/unix_defs.h"', private ] },
-  { include: [ '<sys/socket.h>', public, '"nvim/os/unix_defs.h"', private ] },
-  { include: [ '<termios.h>', public, '"nvim/os/unix_defs.h"', private ] },
-  { include: [ '<unistd.h>', public, '"nvim/os/unix_defs.h"', private ] },
   { include: [ '<uv/unix.h>', public, '<uv.h>', public ] },
 ]
 

src/clint.py

@@ -1090,7 +1090,7 @@ def CheckIncludes(filename, lines, error):
             return
 
     for i, line in enumerate(lines):
-        matched = Match(r'#\s*include\s*"([^"]*)"$', line)
+        matched = Match(r'#\s*include\s*"([^"]*)"', line)
         if matched:
             name = matched.group(1)
             if (not name.endswith('.h.generated.h') and

src/nvim/api/ui.c

@@ -26,7 +26,6 @@
 #include "nvim/mbyte.h"
 #include "nvim/memory.h"
 #include "nvim/msgpack_rpc/channel.h"
-#include "nvim/msgpack_rpc/channel_defs.h"
 #include "nvim/msgpack_rpc/helpers.h"
 #include "nvim/option.h"
 #include "nvim/types.h"

src/nvim/api/vim.c

@@ -48,7 +48,6 @@
 #include "nvim/message.h"
 #include "nvim/move.h"
 #include "nvim/msgpack_rpc/channel.h"
-#include "nvim/msgpack_rpc/channel_defs.h"
 #include "nvim/msgpack_rpc/unpacker.h"
 #include "nvim/ops.h"
 #include "nvim/option.h"

src/nvim/arglist.h

@@ -1,9 +1,9 @@
 #pragma once
 
-#include "nvim/arglist_defs.h"
+#include "nvim/arglist_defs.h"  // IWYU pragma: export
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: keep
-#include "nvim/eval/typval_defs.h"
+#include "nvim/eval/typval_defs.h"  // IWYU pragma: keep
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
 #include "nvim/types.h"
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS

src/nvim/buffer.h

@@ -4,7 +4,7 @@
 #include <stdbool.h>
 #include <stddef.h>
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: export
 #include "nvim/eval/typval.h"
 #include "nvim/eval/typval_defs.h"
 #include "nvim/ex_cmds_defs.h"

src/nvim/cmdexpand.h

@@ -1,9 +1,9 @@
 #pragma once
 
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: export
-#include "nvim/eval/typval_defs.h"
+#include "nvim/eval/typval_defs.h"  // IWYU pragma: keep
 #include "nvim/ex_getln.h"
-#include "nvim/garray_defs.h"
+#include "nvim/garray_defs.h"  // IWYU pragma: keep
 #include "nvim/types.h"
 
 // Values for nextwild() and ExpandOne().  See ExpandOne() for meaning.

src/nvim/decoration.h

@@ -6,7 +6,7 @@
 
 #include "klib/kvec.h"
 #include "nvim/buffer_defs.h"
-#include "nvim/decoration_defs.h"
+#include "nvim/decoration_defs.h"  // IWYU pragma: export
 #include "nvim/extmark_defs.h"
 #include "nvim/macros.h"
 #include "nvim/marktree.h"

src/nvim/eval/funcs.c

@@ -82,7 +82,6 @@
 #include "nvim/message.h"
 #include "nvim/move.h"
 #include "nvim/msgpack_rpc/channel.h"
-#include "nvim/msgpack_rpc/channel_defs.h"
 #include "nvim/msgpack_rpc/server.h"
 #include "nvim/normal.h"
 #include "nvim/ops.h"

src/nvim/eval/typval.h

@@ -6,7 +6,7 @@
 #include <stdint.h>
 #include <string.h>
 
-#include "nvim/eval/typval_defs.h"
+#include "nvim/eval/typval_defs.h"  // IWYU pragma: export
 #include "nvim/func_attr.h"
 #include "nvim/garray_defs.h"
 #include "nvim/gettext.h"

src/nvim/ex_cmds.h

@@ -4,7 +4,7 @@
 
 #include "nvim/buffer_defs.h"
 #include "nvim/eval/typval_defs.h"
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: export
 #include "nvim/os/time.h"
 #include "nvim/pos.h"
 

src/nvim/ex_eval.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
-#include "nvim/ex_eval_defs.h"
+#include "nvim/ex_eval_defs.h"  // IWYU pragma: export
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS
 # include "ex_eval.h.generated.h"

src/nvim/extmark.h

@@ -7,7 +7,7 @@
 #include "klib/kvec.h"
 #include "nvim/buffer_defs.h"
 #include "nvim/decoration.h"
-#include "nvim/extmark_defs.h"
+#include "nvim/extmark_defs.h"  // IWYU pragma: export
 #include "nvim/macros.h"
 #include "nvim/marktree.h"
 #include "nvim/pos.h"

src/nvim/fold.h

@@ -2,9 +2,9 @@
 
 #include <stdio.h>
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
-#include "nvim/fold_defs.h"
+#include "nvim/fold_defs.h"  // IWYU pragma: export
-#include "nvim/garray_defs.h"
+#include "nvim/garray_defs.h"  // IWYU pragma: keep
 #include "nvim/macros.h"
 #include "nvim/pos.h"
 #include "nvim/types.h"

src/nvim/garray.h

@@ -3,7 +3,7 @@
 #include <stdbool.h>
 #include <stddef.h>
 
-#include "nvim/garray_defs.h"
+#include "nvim/garray_defs.h"  // IWYU pragma: export
 #include "nvim/log.h"
 #include "nvim/memory.h"
 #include "nvim/types.h"

src/nvim/getchar.h

@@ -3,8 +3,8 @@
 #include <stdbool.h>
 #include <stdint.h>
 
-#include "nvim/eval/typval_defs.h"
+#include "nvim/eval/typval_defs.h"  // IWYU pragma: keep
-#include "nvim/getchar_defs.h"
+#include "nvim/getchar_defs.h"  // IWYU pragma: export
 #include "nvim/os/fileio.h"
 #include "nvim/types.h"
 

src/nvim/gettext.h

@@ -1,7 +1,7 @@
 #pragma once
 
 #ifdef HAVE_WORKING_LIBINTL
-# include <libintl.h>
+# include <libintl.h>  // IWYU pragma: export
 # define _(x) gettext(x)  // NOLINT(bugprone-reserved-identifier)
 // XXX do we actually need this?
 # ifdef gettext_noop

src/nvim/grid.h

@@ -5,7 +5,7 @@
 
 #include "nvim/ascii.h"
 #include "nvim/buffer_defs.h"
-#include "nvim/grid_defs.h"
+#include "nvim/grid_defs.h"  // IWYU pragma: export
 #include "nvim/macros.h"
 #include "nvim/mbyte.h"
 #include "nvim/memory.h"

src/nvim/highlight.h

@@ -3,10 +3,9 @@
 #include <stdbool.h>
 
 #include "nvim/api/keysets.h"
-#include "nvim/api/private/defs.h"
+#include "nvim/api/private/defs.h"  // IWYU pragma: keep
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
-#include "nvim/highlight_defs.h"
+#include "nvim/highlight_defs.h"  // IWYU pragma: export
-#include "nvim/option_defs.h"
 #include "nvim/option_vars.h"
 #include "nvim/ui.h"
 

src/nvim/mapping.h

@@ -5,13 +5,13 @@
 #include <stdint.h>
 
 #include "nvim/api/keysets.h"
-#include "nvim/api/private/defs.h"
+#include "nvim/api/private/defs.h"  // IWYU pragma: keep
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: keep
-#include "nvim/eval/typval_defs.h"
+#include "nvim/eval/typval_defs.h"  // IWYU pragma: keep
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
-#include "nvim/mapping_defs.h"
+#include "nvim/mapping_defs.h"  // IWYU pragma: export
-#include "nvim/option_defs.h"
+#include "nvim/option_defs.h"  // IWYU pragma: keep
-#include "nvim/regexp_defs.h"
+#include "nvim/regexp_defs.h"  // IWYU pragma: keep
 #include "nvim/types.h"
 
 /// Used for the first argument of do_map()

src/nvim/mark.h

@@ -9,7 +9,7 @@
 #include "nvim/extmark_defs.h"
 #include "nvim/func_attr.h"
 #include "nvim/macros.h"
-#include "nvim/mark_defs.h"
+#include "nvim/mark_defs.h"  // IWYU pragma: export
 #include "nvim/memory.h"
 #include "nvim/os/time.h"
 #include "nvim/pos.h"

src/nvim/mbyte.h

@@ -4,11 +4,11 @@
 #include <stdint.h>
 #include <string.h>
 
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: keep
-#include "nvim/eval/typval_defs.h"
+#include "nvim/eval/typval_defs.h"  // IWYU pragma: keep
 #include "nvim/func_attr.h"
 #include "nvim/grid_defs.h"
-#include "nvim/mbyte_defs.h"
+#include "nvim/mbyte_defs.h"  // IWYU pragma: export
 #include "nvim/os/os_defs.h"
 #include "nvim/types.h"
 

src/nvim/memfile.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
-#include "nvim/memfile_defs.h"
+#include "nvim/memfile_defs.h"  // IWYU pragma: export
 
 /// flags for mf_sync()
 #define MFS_ALL         1       /// also sync blocks with negative numbers

src/nvim/memline.h

@@ -1,6 +1,7 @@
 #pragma once
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
+#include "nvim/memline_defs.h"  // IWYU pragma: export
 #include "nvim/pos.h"
 #include "nvim/types.h"
 

src/nvim/menu.h

@@ -2,9 +2,9 @@
 
 #include <stdbool.h>
 
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: keep
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
-#include "nvim/menu_defs.h"
+#include "nvim/menu_defs.h"  // IWYU pragma: export
 #include "nvim/types.h"
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS

src/nvim/msgpack_rpc/channel.h

@@ -9,6 +9,7 @@
 #include "nvim/event/process.h"
 #include "nvim/event/socket.h"
 #include "nvim/macros.h"
+#include "nvim/msgpack_rpc/channel_defs.h"  // IWYU pragma: export
 #include "nvim/vim.h"
 
 #define METHOD_MAXLEN 512

src/nvim/option.h

@@ -3,10 +3,10 @@
 #include <stdint.h>
 
 #include "nvim/api/private/helpers.h"
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: keep
 #include "nvim/eval/typval_defs.h"
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
-#include "nvim/option_defs.h"
+#include "nvim/option_defs.h"  // IWYU pragma: export
 #include "nvim/search.h"
 
 /// The options that are local to a window or buffer have "indir" set to one of

src/nvim/os/fs.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "nvim/os/fs_defs.h"
+#include "nvim/os/fs_defs.h"  // IWYU pragma: export
 #include "nvim/types.h"
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS

src/nvim/os/os.h

@@ -7,6 +7,7 @@
 #include "nvim/cmdexpand_defs.h"
 #include "nvim/garray_defs.h"
 #include "nvim/os/fs_defs.h"
+#include "nvim/os/os_defs.h"  // IWYU pragma: export
 #include "nvim/os/stdpaths_defs.h"
 #include "nvim/types.h"
 

src/nvim/os/pty_process_unix.h

@@ -1,4 +1,5 @@
 #pragma once
+// IWYU pragma: private, include "nvim/os/pty_process.h"
 
 #include <stdint.h>
 #include <sys/ioctl.h>

src/nvim/os/pty_process_win.h

@@ -1,4 +1,5 @@
 #pragma once
+// IWYU pragma: private, include "nvim/os/pty_process.h"
 
 #include <uv.h>
 

src/nvim/os/unix_defs.h

@@ -1,10 +1,11 @@
 #pragma once
+// IWYU pragma: private, include "nvim/os/os_defs.h"
 
-#include <sys/param.h>
+#include <sys/param.h>  // IWYU pragma: export
-#include <sys/socket.h>
+#include <sys/socket.h>  // IWYU pragma: export
-#include <unistd.h>
+#include <unistd.h>  // IWYU pragma: export
 #if defined(HAVE_TERMIOS_H)
-# include <termios.h>
+# include <termios.h>  // IWYU pragma: export
 #endif
 
 // POSIX.1-2008 says that NAME_MAX should be in here

src/nvim/os/win_defs.h

@@ -1,4 +1,5 @@
 #pragma once
+// IWYU pragma: private, include "nvim/os/os_defs.h"
 
 #ifndef MSWIN
 # error Header must be included only when compiling for Windows.

src/nvim/regexp.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
-#include "nvim/regexp_defs.h"
+#include "nvim/regexp_defs.h"  // IWYU pragma: export
 #include "nvim/types.h"
 
 // Second argument for vim_regcomp().

src/nvim/sign.h

@@ -2,10 +2,10 @@
 
 #include <stdbool.h>
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: keep
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
-#include "nvim/sign_defs.h"
+#include "nvim/sign_defs.h"  // IWYU pragma: export
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS
 # include "sign.h.generated.h"

src/nvim/spell.h

@@ -2,9 +2,9 @@
 
 #include <stdbool.h>
 
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
 #include "nvim/globals.h"
-#include "nvim/spell_defs.h"
+#include "nvim/spell_defs.h"  // IWYU pragma: export
 #include "nvim/vim.h"
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS

src/nvim/statusline.h

@@ -2,9 +2,9 @@
 
 #include <stddef.h>
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
 #include "nvim/macros.h"
-#include "nvim/statusline_defs.h"
+#include "nvim/statusline_defs.h"  // IWYU pragma: export
 
 /// Array defining what should be done when tabline is clicked
 EXTERN StlClickDefinition *tab_page_click_defs INIT( = NULL);

src/nvim/syntax.h

@@ -2,11 +2,12 @@
 
 #include <stdbool.h>
 
-#include "nvim/buffer_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
-#include "nvim/cmdexpand_defs.h"
+#include "nvim/cmdexpand_defs.h"  // IWYU pragma: keep
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
 #include "nvim/globals.h"
 #include "nvim/macros.h"
+#include "nvim/syntax_defs.h"  // IWYU pragma: export
 
 #define HL_CONTAINED   0x01    // not used on toplevel
 #define HL_TRANSP      0x02    // has no highlighting

src/nvim/tui/input.h

@@ -9,7 +9,7 @@
 #include "nvim/event/stream.h"
 #include "nvim/event/time.h"
 #include "nvim/rbuffer.h"
-#include "nvim/tui/input_defs.h"
+#include "nvim/tui/input_defs.h"  // IWYU pragma: export
 #include "nvim/tui/tui.h"
 #include "nvim/types.h"
 

src/nvim/ui_client.c

@@ -17,7 +17,6 @@
 #include "nvim/main.h"
 #include "nvim/memory.h"
 #include "nvim/msgpack_rpc/channel.h"
-#include "nvim/msgpack_rpc/channel_defs.h"
 #include "nvim/os/os_defs.h"
 #include "nvim/tui/tui.h"
 #include "nvim/ui.h"

src/nvim/undo.h

@@ -1,7 +1,8 @@
 #pragma once
 
-#include "nvim/ex_cmds_defs.h"
+#include "nvim/buffer_defs.h"  // IWYU pragma: keep
-#include "nvim/undo_defs.h"
+#include "nvim/ex_cmds_defs.h"  // IWYU pragma: keep
+#include "nvim/undo_defs.h"  // IWYU pragma: export
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS
 # include "undo.h.generated.h"