mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-18 20:17:36 +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.
134 lines
3.3 KiB
C++
134 lines
3.3 KiB
C++
#include <config.h>
|
|
|
|
#include "../support/FileName.h"
|
|
#include "../support/filetools.h"
|
|
#include "../Format.h"
|
|
#include "../LayoutFile.h"
|
|
#include "../LaTeXFeatures.h"
|
|
#include "../Lexer.h"
|
|
#include "../support/Messages.h"
|
|
#include "../support/os.h"
|
|
#include "../support/Package.h"
|
|
|
|
#include <cstdlib>
|
|
#include <fstream>
|
|
#include <iostream>
|
|
#include <sstream>
|
|
using namespace std;
|
|
|
|
|
|
namespace lyx {
|
|
namespace frontend {
|
|
namespace Alert {
|
|
void warning(docstring const & title, docstring const & message, bool const &)
|
|
{
|
|
LYXERR0(title);
|
|
LYXERR0(message);
|
|
}
|
|
} // namespace Alert
|
|
} // namespace frontend
|
|
|
|
bool LaTeXFeatures::isAvailable(std::string const &)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
Formats formats;
|
|
bool Formats::isZippedFile(support::FileName const &) const
|
|
{
|
|
return false;
|
|
}
|
|
} // namespace lyx
|
|
|
|
|
|
using namespace lyx::support;
|
|
using namespace lyx;
|
|
|
|
using namespace std;
|
|
|
|
|
|
bool test_Layout(string const & input, string const & output)
|
|
{
|
|
FileName const ifn(makeAbsPath(input));
|
|
LayoutFileList & l = LayoutFileList::get();
|
|
LayoutFileIndex i = onlyFileName(l.addLocalLayout(ifn.onlyFileName(), ifn.onlyPath().absFileName()));
|
|
if (i.empty()) {
|
|
cerr << "Could not read layout file " << input << ".layout.\n";
|
|
return false;
|
|
}
|
|
LayoutFile const & f = l[i];
|
|
ostream * os = NULL;
|
|
if (output == "-")
|
|
os = &cout;
|
|
else if (!output.empty())
|
|
os = new ofstream(output.c_str());
|
|
bool success = true;
|
|
for (TextClass::const_iterator it = f.begin(); it != f.end(); ++it) {
|
|
if (os)
|
|
it->write(*os);
|
|
ostringstream oss;
|
|
it->write(oss);
|
|
istringstream iss(oss.str());
|
|
// swallow "Style Standard" line
|
|
string line;
|
|
if (getline(iss, line)) {
|
|
Lexer lex;
|
|
lex.setStream(iss);
|
|
Layout test;
|
|
test.setName(it->name());
|
|
if (test.read(lex, f)) {
|
|
// Caution: operator==() is incomplete!
|
|
// Testing test == *it does not make much sense
|
|
// therefore.
|
|
// It does not work either for styles with
|
|
// non-empty obsoletedby if the obsoletedby
|
|
// style was modified after the obsolete style
|
|
// was defined: Layout::write() writes only the
|
|
// final version, but the obsolete style was
|
|
// set to the version at the time it was
|
|
// defined, and therefore they differ. See e.g.
|
|
// the obsolete style AMS which is replaced by
|
|
// Subjectclass in amsdefs.inc, and
|
|
// Subjectclass is modified later in siamltex.layout.
|
|
ostringstream osstest;
|
|
test.write(osstest);
|
|
if (osstest.str() != oss.str()) {
|
|
cerr << "Round trip for style "
|
|
<< to_utf8(it->name())
|
|
<< " failed:\n"
|
|
<< osstest.str() << oss.str();
|
|
success = false;
|
|
}
|
|
} else {
|
|
cerr << "Could not read style "
|
|
<< to_utf8(it->name()) << ".\n";
|
|
success = false;
|
|
}
|
|
} else {
|
|
cerr << "Could not read first line for style "
|
|
<< to_utf8(it->name()) << ".\n";
|
|
success = false;
|
|
}
|
|
}
|
|
if (output != "-")
|
|
delete os;
|
|
return success;
|
|
}
|
|
|
|
|
|
int main(int argc, char * argv[])
|
|
{
|
|
os::init(argc, &argv);
|
|
lyxerr.setStream(cerr);
|
|
if (argc < 2 || argc > 3) {
|
|
cerr << "Usage: " << argv[0] << " <input layout file> [<output layout file>]\n";
|
|
return EXIT_FAILURE;
|
|
}
|
|
FileName const exe(makeAbsPath(os::internal_path(os::utf8_argv(0))));
|
|
string const lyxexe = addName(exe.onlyPath().absFileName(), "lyx");
|
|
init_package(lyxexe, string(), string());
|
|
if (test_Layout(argv[1], argc > 2 ? argv[2] : ""))
|
|
return EXIT_SUCCESS;
|
|
return EXIT_FAILURE;
|
|
}
|