lyx_mirror/src/IndicesList.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

247 lines
4.6 KiB
C++

/**
* \file IndicesList.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "IndicesList.h"
#include "Color.h"
#include "frontends/Application.h"
#include "support/convert.h"
#include "support/lstrings.h"
#include <algorithm>
using namespace std;
using namespace lyx::support;
namespace lyx {
namespace {
class IndexNamesEqual : public std::unary_function<Index, bool>
{
public:
IndexNamesEqual(docstring const & name)
: name_(name)
{}
bool operator()(Index const & index) const
{
return index.index() == name_;
}
private:
docstring name_;
};
class IndexHasShortcut : public std::unary_function<Index, bool>
{
public:
IndexHasShortcut(docstring const & shortcut)
: shortc_(shortcut)
{}
bool operator()(Index const & index) const
{
return index.shortcut() == shortc_;
}
private:
docstring shortc_;
};
} // namespace
/////////////////////////////////////////////////////////////////////
//
// Index
//
/////////////////////////////////////////////////////////////////////
Index::Index()
{
// no theApp() with command line export
if (theApp())
theApp()->getRgbColor(Color_indexlabel, color_);
else
frontend::Application::getRgbColorUncached(Color_indexlabel, color_);
}
docstring const & Index::index() const
{
return index_;
}
void Index::setIndex(docstring const & s)
{
index_ = s;
}
docstring const & Index::shortcut() const
{
return shortcut_;
}
void Index::setShortcut(docstring const & s)
{
shortcut_ = s;
}
RGBColor const & Index::color() const
{
return color_;
}
void Index::setColor(RGBColor const & c)
{
color_ = c;
}
void Index::setColor(string const & str)
{
if (str.size() == 7 && str[0] == '#')
color_ = rgbFromHexName(str);
else {
// no color set or invalid color -- use predefined color
// no theApp() with command line export
if (theApp())
theApp()->getRgbColor(Color_indexlabel, color_);
else
frontend::Application::getRgbColorUncached(Color_indexlabel, color_);
}
}
/////////////////////////////////////////////////////////////////////
//
// IndicesList
//
/////////////////////////////////////////////////////////////////////
Index * IndicesList::find(docstring const & name)
{
List::iterator it =
find_if(list.begin(), list.end(), IndexNamesEqual(name));
return it == list.end() ? 0 : &*it;
}
Index const * IndicesList::find(docstring const & name) const
{
List::const_iterator it =
find_if(list.begin(), list.end(), IndexNamesEqual(name));
return it == list.end() ? 0 : &*it;
}
Index * IndicesList::findShortcut(docstring const & shortcut)
{
List::iterator it =
find_if(list.begin(), list.end(), IndexHasShortcut(shortcut));
return it == list.end() ? 0 : &*it;
}
Index const * IndicesList::findShortcut(docstring const & shortcut) const
{
List::const_iterator it =
find_if(list.begin(), list.end(), IndexHasShortcut(shortcut));
return it == list.end() ? 0 : &*it;
}
bool IndicesList::add(docstring const & n, docstring const & s)
{
bool added = false;
size_t i = 0;
while (true) {
size_t const j = n.find_first_of(separator_, i);
docstring name;
if (j == docstring::npos)
name = n.substr(i);
else
name = n.substr(i, j - i);
// Is this name already in the list?
bool const already =
find_if(list.begin(), list.end(),
IndexNamesEqual(name)) != list.end();
if (!already) {
added = true;
Index in;
in.setIndex(name);
docstring sc = s.empty() ?
trim(lowercase(name.substr(0, 3))) : s;
if (findShortcut(sc) != 0) {
int i = 1;
docstring scn = sc + convert<docstring>(i);
while (findShortcut(scn) != 0) {
++i;
scn = sc + convert<docstring>(i);
}
in.setShortcut(scn);
} else
in.setShortcut(sc);
list.push_back(in);
}
if (j == docstring::npos)
break;
i = j + 1;
}
return added;
}
bool IndicesList::addDefault(docstring const & n)
{
if (findShortcut(from_ascii("idx")) != 0)
// we already have a default
return false;
return add(n, from_ascii("idx"));
}
bool IndicesList::remove(docstring const & s)
{
size_t const size = list.size();
list.remove_if(IndexNamesEqual(s));
return size != list.size();
}
bool IndicesList::rename(docstring const & oldname,
docstring const & newname)
{
if (newname.empty())
return false;
if (find_if(list.begin(), list.end(),
IndexNamesEqual(newname)) != list.end())
// new name already taken
return false;
Index * index = find(oldname);
if (!index)
return false;
index->setIndex(newname);
return true;
}
} // namespace lyx