# Comments start with `#` and last to the end of the line
# Variables are declared first and you can nest variables
# Expansion is specifically `${name}` (this is not shell, so `$name` will not work)
SOURCE_ROOT=/some/path/to/source
OUTPUT_ROOT=${SOURCE_ROOT}/build/out
# The input section describes what files are to be parsed.
# - what include path should be searched for `#include "foo.h"`
# - what files to be parsed using glob rules
input {
# You may include a compile_commands database which will parse
# includes (find `-I` arguments to a compiler)
includes from compiledb ${OUTPUT_ROOT}/compile_commands.json
# You may also manually include single directories
include_dir ${SOURCE_ROOT}/includes/test
include_dir /third/party/lib
# Sources can be loaded directly from a compile database
# for more coverage
#
# NOTE:
# this will include ONLY paths in the current target, and
# targets sometimes do not build all fines in a directory.
# Use glob for full coverage
sources from compiledb ${COMPILE_ROOT}/compile_commands.json
# Globs are generally including all files. program filters
# out based on extensions (h, hpp, c, cpp, cxx, cc)
glob ${SOURCE_ROOT}/src/lib1/**/*
glob ${SOURCE_ROOT}/src/lib2/**/*
}
# The graph section defines how to setup the graph.
graph {
# The tool works with absolute paths when parsing includes
# the `map` section describes how to shorten typically long
# absolute paths like `/home/user/devel/some/path/....`
map {
# Replace some long poath with a short prefix
${SOURCE_ROOT}/src/lib1 => first::
${SOURCE_ROOT}/src/lib2 => second::
# This defines what items to actually keep in the output. Not
# all includes are kept as they would be generally too large.
#
# Only prefix-paths are used here
keep first::
keep second::
# Explicitly remove some of the kept items
drop first::tests/
drop second::support/library
}
# The group section defines how the graph should place
# things together for easy dependency view.
# Group logic:
# - they must be in order of application
# - first group wins (a file belongs to one group only)
group {
# This loads build targets from GN:
# - compile_root is where the `gn` too will be pointed to
# - target defines what GN target to grab `sources` from
# - sources will translate gn paths of `//foo` into absolute
# system paths
gn root ${OUTPUT_ROOT} target //src/app/* sources ${SOURCE_ROOT}
# Sometimes GN targets may include the same file several times
# in that case you may choose to ignore some targets
gn root ${OUTPUT_ROOT} target //src/app/* sources ${SOURCE_ROOT} ignore targets {
//gn/taget1
//gn/taget2:name
//gn/taget3:other-name
}
# Groups can be manually defined to group some files
manual group-name-here {
# Grouping is done by mapped names
first::platform/Header.h
first::platform/Src.cpp
first::Something.cc
}
# Manual groups may have an optional color
manual group-name-here color lightblue {
# Grouping is done by mapped names
first::some/other_header.h
}
# Optional instructions to ensure headers and sources
# are grouped together (as they are generally included in
# the same compilation unit)
group_source_header
}
# you can optionally provide instructions for edge coloring
color edges {
from some_group_name red
to other_group_name blue
}
# If zoom is non-empty it generates a separate area
# with the specified "groups" expanded and viewing individual
# members and dependencies
zoom {
# The zoom takes the group name argument, which could
# be the GN group name or the manual group name
//src/library:support
group-name-here
# Focus prefix means to focus on determining dependencies
# in and out of the specified group(s).
#
# Dependences from other zoomed items will only be show
# if internal or they start/end in a focused zoo group
focus: //src/library:foo
focus: //src/something/else:else
}
}