lyx_mirror/src/BranchList.cpp
Christian Ridderström e30f3d76d2 Bulk cleanup/fix incorrect annotation at the end of namespaces.
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.
2017-07-23 13:11:54 +02:00

213 lines
3.7 KiB
C++

/**
* \file BranchList.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Martin Vermeer
* \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "BranchList.h"
#include "Color.h"
#include "frontends/Application.h"
#include "support/lstrings.h"
#include <algorithm>
using namespace std;
namespace lyx {
namespace {
class BranchNamesEqual : public std::unary_function<Branch, bool>
{
public:
BranchNamesEqual(docstring const & name)
: name_(name)
{}
bool operator()(Branch const & branch) const
{
return branch.branch() == name_;
}
private:
docstring name_;
};
} // namespace
Branch::Branch()
: selected_(false), filenameSuffix_(false)
{
// no theApp() with command line export
if (theApp())
theApp()->getRgbColor(Color_background, color_);
else
frontend::Application::getRgbColorUncached(Color_background, color_);
}
docstring const & Branch::branch() const
{
return branch_;
}
void Branch::setBranch(docstring const & s)
{
branch_ = s;
}
bool Branch::isSelected() const
{
return selected_;
}
bool Branch::setSelected(bool b)
{
if (b == selected_)
return false;
selected_ = b;
return true;
}
bool Branch::hasFileNameSuffix() const
{
return filenameSuffix_;
}
void Branch::setFileNameSuffix(bool b)
{
filenameSuffix_ = b;
}
RGBColor const & Branch::color() const
{
return color_;
}
void Branch::setColor(RGBColor const & c)
{
color_ = c;
}
void Branch::setColor(string const & str)
{
if (str.size() == 7 && str[0] == '#')
color_ = rgbFromHexName(str);
else {
// no color set or invalid color - use normal background
// no theApp() with command line export
if (theApp())
theApp()->getRgbColor(Color_background, color_);
else
frontend::Application::getRgbColorUncached(Color_background, color_);
}
}
Branch * BranchList::find(docstring const & name)
{
List::iterator it =
find_if(list.begin(), list.end(), BranchNamesEqual(name));
return it == list.end() ? 0 : &*it;
}
Branch const * BranchList::find(docstring const & name) const
{
List::const_iterator it =
find_if(list.begin(), list.end(), BranchNamesEqual(name));
return it == list.end() ? 0 : &*it;
}
bool BranchList::add(docstring const & s)
{
bool added = false;
size_t i = 0;
while (true) {
size_t const j = s.find_first_of(separator_, i);
docstring name;
if (j == docstring::npos)
name = s.substr(i);
else
name = s.substr(i, j - i);
// Is this name already in the list?
bool const already =
find_if(list.begin(), list.end(),
BranchNamesEqual(name)) != list.end();
if (!already) {
added = true;
Branch br;
br.setBranch(name);
br.setSelected(false);
br.setFileNameSuffix(false);
list.push_back(br);
}
if (j == docstring::npos)
break;
i = j + 1;
}
return added;
}
bool BranchList::remove(docstring const & s)
{
size_t const size = list.size();
list.remove_if(BranchNamesEqual(s));
return size != list.size();
}
bool BranchList::rename(docstring const & oldname,
docstring const & newname, bool const merge)
{
if (newname.empty())
return false;
if (find_if(list.begin(), list.end(),
BranchNamesEqual(newname)) != list.end()) {
// new name already taken
if (merge)
return remove(oldname);
return false;
}
Branch * branch = find(oldname);
if (!branch)
return false;
branch->setBranch(newname);
return true;
}
docstring BranchList::getFileNameSuffix() const
{
docstring result;
List::const_iterator it = list.begin();
for (; it != list.end(); ++it) {
if (it->isSelected() && it->hasFileNameSuffix())
result += "-" + it->branch();
}
return support::subst(result, from_ascii("/"), from_ascii("_"));
}
} // namespace lyx