lyx_mirror/src/frontends/qt4/GuiIdListModel.h
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

127 lines
3.9 KiB
C++

// -*- C++ -*-
/**
* \file GuiIdListModel.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Richard Heck
*
* Some of this code is based upon qstringlistmodel.{h,cpp}, which is
* part of the Qt toolkit, copyright (C) 1992-2007 Trolltech ASA, and
* released under the General Public License.
*
* Full author contact details are available in file CREDITS.
*/
#ifndef GUIIDLISTMODEL_H
#define GUIIDLISTMODEL_H
#include "support/qstring_helpers.h"
#include <QAbstractListModel>
#include <vector>
#include <string>
namespace lyx {
namespace frontend {
/**
* A QAbstractListModel that associates an identifying string with
* each item, as well as a display string. The display string is set
* with setUIString; the identifying string, with setIDString.
*
* This is intended to be used, for example, with GuiSelectionManager.
* In that case, one needs to recover from selectedModel which items
* have been selected. One may not wish to do so using the string that
* is there *displayed*, since, among other things, that string may be
* translated. So the id can be used to identify the items in this case.
*/
class GuiIdListModel : public QAbstractListModel {
public:
///
GuiIdListModel() {}
//////////////////////////////////////////////////////////////////////
// Methods overridden from QAbstractListModel
//////////////////////////////////////////////////////////////////////
///
int rowCount(QModelIndex const & = QModelIndex()) const
{ return userData_.size(); }
///
virtual QVariant data(QModelIndex const & index,
int role = Qt::DisplayRole) const;
///
bool insertRows(int row, int count, QModelIndex const & parent = QModelIndex());
///
bool removeRows(int row, int count, QModelIndex const & parent = QModelIndex());
///
void clear() { removeRows(0, rowCount()); }
///
virtual bool setData (QModelIndex const & index,
const QVariant & value, int role = Qt::EditRole );
///
virtual QMap<int, QVariant> itemData(QModelIndex const & index ) const;
//////////////////////////////////////////////////////////////////////
// New methods
//////////////////////////////////////////////////////////////////////
///
void insertRow(int const i, QString const & uiString,
std::string const & idString, QString const & ttString);
/// A convenience method, setting ttString to the same as uiString
void insertRow(int const i, QString const & uiString,
std::string const & idString);
/// \return the index of the (first) item with idString
/// \return -1 if not found
int findIDString(std::string const & idString);
///
virtual QString getIDString(QModelIndex const & index) const
{ return data(index, Qt::UserRole).toString(); }
///
virtual std::string getIDString(int const i) const
{ return fromqstr(getIDString(index(i))); }
private:
/// noncopyable
GuiIdListModel(GuiIdListModel const &);
///
void operator=(GuiIdListModel const &);
///
void setUIString(QModelIndex const & index, QString const & value)
{ setData(index, value); }
///
void setUIString(int const i, QString const & value)
{ setUIString(index(i), value); }
///
void setIDString(QModelIndex const & index, QString const & value)
{ setData(index, value, Qt::UserRole); }
///
void setIDString(int const i, std::string const & value)
{ setIDString(index(i), toqstr(value)); }
///
void setTTString(QModelIndex const & index, QString const & value)
{ setData(index, value, Qt::ToolTipRole); }
///
void setTTString(int const i, QString const & value)
{ setTTString(index(i), value); }
struct OurData {
/// Qt::DisplayRole and Qt::EditRole
QVariant uiString;
/// Qt::UserRole
QVariant idString;
/// Qt::ToolTipRole
QVariant ttString;
};
///
std::vector<OurData> userData_;
///
bool rowIsValid(int const i) const
{
return i >= 0 && i <= int(userData_.size());
}
};
} // namespace frontend
} // namespace lyx
#endif //GUIIDLISTMODEL_H