libclang

libclang
Name	libclang
Developer	Apple Inc., LLVM Project
Released	2007
Programming language	C++, C
Operating system	Linux, Windows, macOS
License	Apache License

libclang is a C interface to the Clang front end of the LLVM Project that exposes parsing, semantic analysis, and tooling facilities for C, C++, and Objective-C. It serves as a stable, language-neutral bridge between compiler internals and external tools such as editors, analyzers, and build systems. libclang is widely used across projects in the Free Software Foundation, Google, Microsoft, Apple Inc., and academic research at institutions like MIT, Stanford University, and University of California, Berkeley.

Overview

libclang was created as part of the broader LLVM Project and Clang initiative to provide a reusable frontend for C-family languages that separates parsing from backend code generation. It provides an Application Programming Interface used by editors like Visual Studio Code, Xcode, and Eclipse CDT and by static analysis tools such as Coverity, Cppcheck, and Clang-Tidy. The interface enables integration with continuous integration systems like Jenkins, Travis CI, and GitHub Actions, and with package managers and build tools such as CMake, Bazel, and Meson.

Architecture and Components

libclang sits atop the Clang AST and LLVM IR pipeline and exposes components including tokenization, preprocessing, Abstract Syntax Tree (AST) cursors, type information, diagnostics, and source-location mapping. Key internal projects and technologies that intersect with libclang include Clang Static Analyzer, LLDB, Polly, and Sanitizer runtimes like AddressSanitizer and UndefinedBehaviorSanitizer. The architecture interacts with system toolchains such as GCC and MSVC and with platform SDKs from Apple Inc. and Microsoft. Components are organized to support incremental parsing for editors developed by corporations such as JetBrains and research groups at Carnegie Mellon University.

API and Usage

The libclang API exposes functions to create translation units, traverse AST cursors, retrieve source ranges, and obtain type and diagnostic information. Typical usage patterns occur in language servers like Microsoft Language Server Protocol implementations, IDEs such as CLion, and browser-based editors backed by services like Emscripten and Chromium. Developers often call libclang from tooling stacks employing Python, Rust, Go, Java, or C# to analyze projects managed by Autotools or Ninja. libclang's diagnostic and fix-it APIs are used by code refactoring tools that integrate with LLVM's TableGen, GitLab, and Phabricator workflows.

Bindings and Language Support

A wide ecosystem of bindings wraps libclang for languages and runtimes: Python bindings used by Sublime Text plugins and Anaconda (Python distribution), Rust crates for projects like Servo, Go packages for tools within Kubernetes-adjacent projects, Haskell bindings used in academic tools, and Java wrappers used by Eclipse-based IDEs. Language servers and tooling projects in the ecosystem include clangd, ccls, and integrations for editors like Vim, Neovim, and Emacs. Bindings enable cross-platform projects supported by cloud providers like Amazon Web Services, Google Cloud Platform, and Microsoft Azure.

Tooling and Applications

libclang underpins static analysis, refactoring, indexing, autocompletion, and code navigation tools. Prominent adopters and related projects include Clang-Tidy, Clang-Format, clangd, Bear (build tool), and research tools from Google and Facebook. It is used in large-scale code search and mining systems developed at GitHub, Bitbucket, and enterprise tools at Intel and NVIDIA. Academic and industrial research projects leveraging libclang include program understanding efforts at University of Cambridge, ETH Zurich, and IMDEA Software Institute.

Development and Licensing

Development of libclang follows the governance model of the LLVM Project, with contributions from individuals at Apple Inc., Google, Intel, ARM Holdings, and independent contributors. The project adheres to an open development process conducted on mailing lists, code review via Phabricator or Gerrit, and nightly builds for Travis CI or Jenkins nodes. libclang is distributed under permissive terms consistent with the Apache License used by the LLVM Project, allowing commercial and academic use by organizations including Red Hat, Canonical (company), SUSE, and Oracle Corporation.

Category:Software development tools