Differential D24568 Diff 68186 kde-modules/KDEClangFormat.cmake

Changeset View

Standalone View

View Options

kde-modules/KDEClangFormat.cmake

  • This file was added.
1​#.rst:
2​# KDEClangFormat
3​# --------------------
4​#
5​# This module provides a functionality to format the source
6​# code of your repository according to a predefined KDE
7​# clang-format file.
8​#
9​# This module provides the following function:
10​#
11​# ::
12​#
ognarbUnsubmitted
Done

need doc

ognarb: need doc
cullmannAuthorUnsubmitted
Done

Added some initial docs

cullmann: Added some initial docs
13​# kde_clang_format(<files>)
14​#
15​# Using this function will create a clang-format target that will format all
16​# <files> passed to the function with the predefined KDE clang-format style.
17​#
18​# Example usage:
19​#
20​# include(KDEClangFormat)
21​# file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES src/*.cpp src/*.h)
22​# kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES})
23​#
24​# Since 5.64
25​
26​#=============================================================================
27​# Copyright 2019 Christoph Cullmann <cullmann@kde.org>
28​#
29​# Redistribution and use in source and binary forms, with or without
30​# modification, are permitted provided that the following conditions
31​# are met:
32​#
33​# 1. Redistributions of source code must retain the copyright
34​# notice, this list of conditions and the following disclaimer.
35​# 2. Redistributions in binary form must reproduce the copyright
36​# notice, this list of conditions and the following disclaimer in the
37​# documentation and/or other materials provided with the distribution.
38​# 3. The name of the author may not be used to endorse or promote products
39​# derived from this software without specific prior written permission.
40​#
41​# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
42​# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43​# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
44​# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
45​# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46​# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47​# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48​# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49​# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
davidedmundsonUnsubmitted
Not Done

it's a bit weird to put new files in the source directory when running cmake.

Copying when running the target clang-format would probably be ok as there you're already doing an explicit operation which changes the source.

davidedmundson: it's a bit weird to put new files in the source directory when running cmake. Copying when…
cullmannAuthorUnsubmitted
Not Done

If we don't do this per default, user clang-format tooling like via LSP in Atom/Vscode/Kate will not work properly before a manual action.

cullmann: If we don't do this per default, user clang-format tooling like via LSP in Atom/Vscode/Kate…
50​# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51​
52​# try to find clang-format in path
53​find_program(KDE_CLANG_FORMAT_EXECUTABLE clang-format)
54​
sitterUnsubmitted
Done

I'm pretty sure you need to check the version the exectuable. When I use 6.0 I get ctors smushed into one line.

sitter: I'm pretty sure you need to check the version the exectuable. When I use 6.0 I get ctors…
cullmannAuthorUnsubmitted
Not Done

No, actually the reason for that is the added BreakConstructorInitializers: BeforeColon
I am not sure how to avoid that if we not go back to the old variant I had without that.

cullmann: No, actually the reason for that is the added BreakConstructorInitializers: BeforeColon I am…
55​# instantiate our clang-format file, must be in source directory for tooling if we have the tool
56​if(KDE_CLANG_FORMAT_EXECUTABLE)
57​ configure_file(${CMAKE_CURRENT_LIST_DIR}/clang-format.cmake ${CMAKE_CURRENT_SOURCE_DIR}/.clang-format @ONLY)
58​endif()
59​
60​# formatting target
61​function(KDE_CLANG_FORMAT)
62​ # add target only if clang-format available
63​ if(KDE_CLANG_FORMAT_EXECUTABLE)
64​ add_custom_target(clang-format
65​ COMMAND
66​ ${KDE_CLANG_FORMAT_EXECUTABLE}
67​ -style=file
68​ -i
69​ ${ARGV}
70​ WORKING_DIRECTORY
71​ ${CMAKE_CURRENT_SOURCE_DIR}
72​ COMMENT
73​ "Formatting sources in ${CMAKE_CURRENT_SOURCE_DIR} with ${KDE_CLANG_FORMAT_EXECUTABLE}..."
74​ )
75​ else()
76​ add_custom_target(clang-format
77​ COMMAND
dfaureUnsubmitted
Not Done

I wonder if people compiling KF5 modules (and not necessarily planning on contributing) need to be annoyed with such a warning. Maybe we could still define the clang-format target and make it print an error?

dfaure: I wonder if people compiling KF5 modules (and not necessarily planning on contributing) need to…
cullmannAuthorUnsubmitted
Not Done

Yeah, I think some message on running the target will be less annoying.

cullmann: Yeah, I think some message on running the target will be less annoying.
78​ ${CMAKE_COMMAND} -E echo
79​ "Could not set up the clang-format target as the clang-format executable is missing."
80​ )
81​ endif()
82​endfunction()