mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-22 18:08:10 +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.
115 lines
3.3 KiB
C++
115 lines
3.3 KiB
C++
// -*- C++ -*-
|
|
|
|
// Heavily inspired by /usr/include/c++/4.1/bits
|
|
//
|
|
// Copyright (C) 2001, 2002 Free Software Foundation, Inc.
|
|
//
|
|
// This file is part of the GNU ISO C++ Library. This library is free
|
|
// software; you can redistribute it and/or modify it under the
|
|
// terms of the GNU General Public License as published by the
|
|
// Free Software Foundation; either version 2, or (at your option)
|
|
// any later version.
|
|
|
|
#ifndef STRFWD_H
|
|
#define STRFWD_H
|
|
|
|
#ifdef USE_WCHAR_T
|
|
|
|
// Prefer this if possible because GNU libstdc++ has usable
|
|
// std::ctype<wchar_t> locale facets but not
|
|
// std::ctype<boost::uint32_t>. gcc older than 3.4 is also missing
|
|
// usable std::char_traits<boost::uint32_t>.
|
|
namespace lyx { typedef wchar_t char_type; }
|
|
|
|
#else
|
|
|
|
#if defined(_MSC_VER) && (_MSC_VER >= 1600)
|
|
#include <cstdint>
|
|
namespace lyx { typedef uint32_t char_type; }
|
|
#include "support/numpunct_lyx_char_type.h" // implementation for our char_type needed
|
|
#else
|
|
#include <boost/cstdint.hpp>
|
|
namespace lyx { typedef boost::uint32_t char_type; }
|
|
#endif
|
|
|
|
#endif
|
|
|
|
// Forward definitions do not work with libc++
|
|
// For gcc5 with the new std::string ABI forward declarations would work in
|
|
// principle, but I am not sure whether we want non-standard
|
|
// "namespace __cxx11" in our sources.
|
|
#if defined(USE_LLVM_LIBCPP) || defined(USE_GLIBCXX_CXX11_ABI)
|
|
#include <string>
|
|
#else
|
|
|
|
namespace std {
|
|
|
|
template<typename Alloc> class allocator;
|
|
|
|
template<typename Char> struct char_traits;
|
|
template<> struct char_traits<char>;
|
|
#ifdef USE_WCHAR_T
|
|
template<> struct char_traits<wchar_t>;
|
|
#endif
|
|
|
|
template<typename Char, typename Traits, typename Alloc> class basic_string;
|
|
typedef basic_string<char, char_traits<char>, allocator<char> > string;
|
|
|
|
template<class Char, class Traits> class basic_istream;
|
|
template<class Char, class Traits> class basic_ostream;
|
|
template<class Char, class Traits, class Allocator> class basic_ostringstream;
|
|
|
|
typedef basic_istream<char, char_traits<char> > istream;
|
|
typedef basic_ostream<char, char_traits<char> > ostream;
|
|
typedef basic_ostringstream<char, char_traits<char>, allocator<char> > ostringstream;
|
|
|
|
} // namespace std
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
namespace lyx {
|
|
|
|
/**
|
|
* String type for storing the main text in UCS4 encoding.
|
|
* Use std::string only in cases 7-bit ASCII is to be manipulated
|
|
* within the variable.
|
|
*/
|
|
typedef std::basic_string<char_type, std::char_traits<char_type>,
|
|
std::allocator<char_type> > docstring;
|
|
|
|
/// Base class for UCS4 input streams
|
|
typedef std::basic_istream<char_type, std::char_traits<char_type> > idocstream;
|
|
|
|
/// Base class for UCS4 output streams
|
|
typedef std::basic_ostream<char_type, std::char_traits<char_type> > odocstream;
|
|
|
|
/// UCS4 output stringstream
|
|
typedef std::basic_ostringstream<char_type, std::char_traits<char_type>, std::allocator<char_type> > odocstringstream;
|
|
|
|
#if ! defined(USE_WCHAR_T)
|
|
extern odocstream & operator<<(odocstream &, char);
|
|
#endif
|
|
|
|
// defined in lstrings.cpp
|
|
docstring const & empty_docstring();
|
|
std::string const & empty_string();
|
|
// defined in docstring.cpp
|
|
bool operator==(docstring const &, char const *);
|
|
|
|
#ifdef STD_STRING_USES_COW
|
|
template<typename Char> class trivial_string;
|
|
typedef trivial_string<char> trivstring;
|
|
typedef trivial_string<char_type> trivdocstring;
|
|
#else
|
|
typedef std::string trivstring;
|
|
typedef docstring trivdocstring;
|
|
#endif
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|