mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-16 07:55:41 +00:00
e30f3d76d2
This commit does a bulk fix of incorrect annotations (comments) at the
end of namespaces.
The commit was generated by initially running clang-format, and then
from the diff of the result extracting the hunks corresponding to
fixes of namespace comments. The changes being applied and all the
results have been manually reviewed. The source code successfully
builds on macOS.
Further details on the steps below, in case they're of interest to
someone else in the future.
1. Checkout a fresh and up to date version of src/
git pull && git checkout -- src && git status src
2. Ensure there's a suitable .clang-format in place, i.e. with options
to fix the comment at the end of namespaces, including:
FixNamespaceComments: true
SpacesBeforeTrailingComments: 1
and that clang-format is >= 5.0.0, by doing e.g.:
clang-format -dump-config | grep Comments:
clang-format --version
3. Apply clang-format to the source:
clang-format -i $(find src -name "*.cpp" -or -name "*.h")
4. Create and filter out hunks related to fixing the namespace
git diff -U0 src > tmp.patch
grepdiff '^} // namespace' --output-matching=hunk tmp.patch > fix_namespace.patch
5. Filter out hunks corresponding to simple fixes into to a separate patch:
pcregrep -M -e '^diff[^\n]+\nindex[^\n]+\n--- [^\n]+\n\+\+\+ [^\n]+\n' \
-e '^@@ -[0-9]+ \+[0-9]+ @@[^\n]*\n-\}[^\n]*\n\+\}[^\n]*\n' \
fix_namespace.patch > fix_namespace_simple.patch
6. Manually review the simple patch and then apply it, after first
restoring the source.
git checkout -- src
patch -p1 < fix_namespace_simple.path
7. Manually review the (simple) changes and then stage the changes
git diff src
git add src
8. Again apply clang-format and filter out hunks related to any
remaining fixes to the namespace, this time filter with more
context. There will be fewer hunks as all the simple cases have
already been handled:
clang-format -i $(find src -name "*.cpp" -or -name "*.h")
git diff src > tmp.patch
grepdiff '^} // namespace' --output-matching=hunk tmp.patch > fix_namespace2.patch
9. Manually review/edit the resulting patch file to remove hunks for files
which need to be dealt with manually, noting the file names and
line numbers. Then restore files to as before applying clang-format
and apply the patch:
git checkout src
patch -p1 < fix_namespace2.patch
10. Manually fix the files noted in the previous step. Stage files,
review changes and commit.
85 lines
2.1 KiB
C++
85 lines
2.1 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file RefChanger.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Guillaume Munch
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef LYX_REFCHANGER_H
|
|
#define LYX_REFCHANGER_H
|
|
|
|
#include "support/Changer.h"
|
|
|
|
|
|
namespace lyx {
|
|
|
|
/// A RefChanger records the current value of \param ref, allowing to
|
|
/// temporarily assign new values to it. The original value is restored
|
|
/// automatically when the object is destroyed, unless it is disabled.
|
|
///
|
|
/// RefChanger is movable, and doing so prolongs the duration of the temporary
|
|
/// assignment. This allows classes to supply their own changer methods.
|
|
///
|
|
/// Naturally, be careful not to extend the life of a RefChanger beyond that of
|
|
/// the reference it modifies. The RefChanger can be disabled by calling
|
|
/// ->keep() or ->revert(). Once disabled, the reference is never accessed
|
|
/// again.
|
|
template<typename X>
|
|
class RevertibleRef : public Revertible {
|
|
public:
|
|
RevertibleRef(X & ref) : ref(ref), old(ref), enabled(true) {}
|
|
//
|
|
~RevertibleRef() { revert(); }
|
|
//
|
|
void revert() { if (enabled) { enabled = false; ref = old; } }
|
|
//
|
|
void keep() { enabled = false; }
|
|
//
|
|
X & ref;
|
|
X const old;
|
|
private:
|
|
bool enabled;
|
|
};
|
|
|
|
|
|
//for gcc 4.6
|
|
#if defined(__GNUC__) && (__GNUC__ == 4) && (__GNUC_MINOR__ == 6)
|
|
template <typename X>
|
|
struct RefChanger : unique_ptr<RevertibleRef<X>>
|
|
{
|
|
RefChanger(unique_ptr<RevertibleRef<X>> p)
|
|
: unique_ptr<RevertibleRef<X>>(move(p))
|
|
{}
|
|
};
|
|
#else
|
|
template <typename X> using RefChanger = unique_ptr<RevertibleRef<X>>;
|
|
#endif
|
|
|
|
|
|
/// Saves the value of \param ref in a movable object
|
|
template <typename X> RefChanger<X> make_save(X & ref)
|
|
{
|
|
return make_unique<RevertibleRef<X>>(ref);
|
|
}
|
|
|
|
/// Temporarily assign value val to reference ref.
|
|
/// To apply the change conditionnally, one can write:
|
|
/// Changer dummy = (cond) ? make_change(a, b) : Changer();
|
|
template <typename X>
|
|
RefChanger<X> make_change(X & ref, X const val)
|
|
{
|
|
auto rc = make_save(ref);
|
|
ref = val;
|
|
return rc;
|
|
}
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
|
|
#endif //LYX_REFCHANGER_H
|