Skip to content

justbuchanan/bazel_rules_qt

Repository files navigation

Circle CI (Linux) AppVeyor (Windows) Bazel CI
ci status ci status ci status

Bazel rules for Qt

These Bazel rules and BUILD targets make it easy to use Qt from C++ projects built with Bazel.

Note that unlike many libraries used through Bazel, it requires Qt to be installed when building the application. Also keep in mind that these rules only allow to link Qt dynamically. In addition in the case of Linux it also requires Qt to be installed on the system when running it. For Windows, it is not needed to have Qt installed in the system to run your program. The needed DLL files are copied to the output folder to make it self-contained. However, Qt is still dynamically linked.

Platform support

This project currently works on Linux, Windows, and macOS.

Usage

You can either copy the qt.BUILD and qt.bzl files into your project, add this project as a submodule if you're using git, or use a git_repository rule to fetch the rules.

Configure your WORKSPACE to include the Qt libraries:

# WORKSPACE

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(
    name = "com_justbuchanan_rules_qt",
    remote = "https://github.com/justbuchanan/bazel_rules_qt.git",
    branch = "master",
)

load("@com_justbuchanan_rules_qt//:qt_configure.bzl", "qt_configure")

qt_configure()

load("@local_config_qt//:local_qt.bzl", "local_qt_path")

new_local_repository(
    name = "qt",
    build_file = "@com_justbuchanan_rules_qt//:qt.BUILD",
    path = local_qt_path(),
)

load("@com_justbuchanan_rules_qt//tools:qt_toolchain.bzl", "register_qt_toolchains")
register_qt_toolchains()

Use the build rules provided by qt.bzl to build your project. See qt.bzl for which rules are available.

# BUILD

load("@com_justbuchanan_rules_qt//:qt.bzl", "qt_cc_library", "qt_ui_library")

qt_cc_library(
    name = "MyWidget",
    srcs = ["MyWidget.cc"],
    hdrs = ["MyWidget.h"],
    deps = ["@qt//:qt_widgets"],
)

qt_ui_library(
    name = "mainwindow",
    ui = "mainwindow.ui",
    deps = ["@qt//:qt_widgets"],
)

cc_binary(
    name = "main",
    srcs = ["main.cpp"],
    copts = ["-fpic"],
    deps = [
        "@qt//:qt_widgets",
        ":MyWidget",
        ":mainwindow",
    ],
)

Credits

This is a fork of https://github.com/bbreslauer/qt-bazel-example with many modifications.