Skip to content

Convenience function for interacting with compile_commands_impl #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nettle wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Convenience function for interacting with compile_commands_impl #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/compile_commands.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,27 @@ def compile_commands_impl(ctx):
),
]

def get_compile_commands(ctx, check=True):
Copy link
Contributor

@Szelethus Szelethus Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I can see, the only meaningful difference here and #141 is the check parameter. Why would ever want to skip these checks though?

Copy link
Collaborator Author

@nettle nettle Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting files from DefaultInfo provider is a kind of common operation. Theoretically we can also get empty list or no list, and none of these is necessary a fail. That actually may apply to compile_commands.json file as well. We add checks only to handle our specific scenario. To be honest , generalizing this as a function does not look much useful to me.

""" Returns the compilation database file

Returns:
compile_commands.json File object
"""
compile_commands = None
source_files = None
for output in compile_commands_impl(ctx):
if type(output) == "DefaultInfo":
compile_commands = output.files.to_list()[0]
source_files = output.default_runfiles.files.to_list()
# FIXME: there should be just one file
if check and not compile_commands:
fail("Failed to generate compile_commands.json file!")
if check and not source_files:
fail("Failed to collect source files!")
if check and compile_commands != ctx.outputs.compile_commands:
fail("Seems compile_commands.json file is incorrect!")
return compile_commands

_compile_commands = rule(
implementation = compile_commands_impl,
attrs = {
Expand Down