mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-16 07:55:41 +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.
433 lines
9.2 KiB
C++
433 lines
9.2 KiB
C++
/**
|
|
* \file ExternalTransforms.cpp
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Angus Leeming
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#include <config.h>
|
|
|
|
#include "ExternalTransforms.h"
|
|
|
|
#include "support/convert.h"
|
|
#include "support/debug.h"
|
|
#include "support/lstrings.h"
|
|
#include "support/lyxlib.h" // float_equal
|
|
#include "support/Translator.h"
|
|
|
|
#include "support/regex.h"
|
|
|
|
#include <cmath> // abs
|
|
#include <sstream>
|
|
|
|
using namespace std;
|
|
using namespace lyx::support;
|
|
|
|
namespace lyx {
|
|
namespace external {
|
|
|
|
|
|
string const ExtraData::get(string const & id) const
|
|
{
|
|
map<string, string>::const_iterator it = data_.find(id);
|
|
return it == data_.end() ? string() : it->second;
|
|
}
|
|
|
|
|
|
void ExtraData::set(string const & id, string const & data)
|
|
{
|
|
data_[id] = data;
|
|
}
|
|
|
|
|
|
bool ResizeData::no_resize() const
|
|
{
|
|
return !usingScale() && width.zero() && height.zero();
|
|
}
|
|
|
|
|
|
bool ResizeData::usingScale() const
|
|
{
|
|
return (!scale.empty() && !float_equal(convert<double>(scale), 0.0, 0.05));
|
|
}
|
|
|
|
|
|
bool RotationData::no_rotation() const
|
|
{
|
|
return (angle.empty() || abs(convert<double>(angle)) < 0.1);
|
|
}
|
|
|
|
|
|
string const RotationData::adjAngle() const
|
|
{
|
|
// Ensure that angle lies in the range -360 < angle < 360
|
|
double rotAngle = convert<double>(angle);
|
|
if (abs(rotAngle) > 360.0) {
|
|
rotAngle -= 360.0 * floor(rotAngle / 360.0);
|
|
return convert<string>(rotAngle);
|
|
}
|
|
return angle;
|
|
}
|
|
|
|
|
|
namespace {
|
|
|
|
typedef Translator<RotationData::OriginType, string> OriginTranslator;
|
|
OriginTranslator const & originTranslator();
|
|
|
|
} // namespace
|
|
|
|
|
|
void RotationData::origin(string const & o)
|
|
{
|
|
origin_ = originTranslator().find(o);
|
|
}
|
|
|
|
|
|
string const RotationData::originString() const
|
|
{
|
|
return originTranslator().find(origin_);
|
|
}
|
|
|
|
|
|
string const ResizeLatexCommand::front_impl() const
|
|
{
|
|
if (data.no_resize())
|
|
return string();
|
|
|
|
ostringstream os;
|
|
if (data.usingScale()) {
|
|
double const scl = convert<double>(data.scale) / 100.0;
|
|
os << "\\scalebox{" << scl << "}[" << scl << "]{";
|
|
} else {
|
|
string width = "!";
|
|
string height = "!";
|
|
if (data.keepAspectRatio) {
|
|
if (data.width.inPixels(10) > data.height.inPixels(10))
|
|
width = data.width.asLatexString();
|
|
else
|
|
height = data.height.asLatexString();
|
|
} else {
|
|
if (!data.width.zero())
|
|
width = data.width.asLatexString();
|
|
if (!data.height.zero())
|
|
height = data.height.asLatexString();
|
|
}
|
|
|
|
os << "\\resizebox{"
|
|
<< width << "}{"
|
|
<< height << "}{";
|
|
}
|
|
return os.str();
|
|
}
|
|
|
|
|
|
string const ResizeLatexCommand::back_impl() const
|
|
{
|
|
if (data.no_resize())
|
|
return string();
|
|
|
|
return "}";
|
|
}
|
|
|
|
|
|
namespace {
|
|
|
|
ostream & operator<<(ostream & os, RotationData::OriginType type)
|
|
{
|
|
switch (type) {
|
|
case RotationData::DEFAULT:
|
|
case RotationData::CENTER:
|
|
break;
|
|
case RotationData::TOPLEFT:
|
|
case RotationData::TOPCENTER:
|
|
case RotationData::TOPRIGHT:
|
|
os << 't';
|
|
break;
|
|
case RotationData::BOTTOMLEFT:
|
|
case RotationData::BOTTOMCENTER:
|
|
case RotationData::BOTTOMRIGHT:
|
|
os << 'b';
|
|
break;
|
|
case RotationData::BASELINELEFT:
|
|
case RotationData::BASELINECENTER:
|
|
case RotationData::BASELINERIGHT:
|
|
os << 'B';
|
|
break;
|
|
}
|
|
|
|
switch (type) {
|
|
case RotationData::DEFAULT:
|
|
break;
|
|
case RotationData::TOPLEFT:
|
|
case RotationData::BOTTOMLEFT:
|
|
case RotationData::BASELINELEFT:
|
|
os << 'l';
|
|
break;
|
|
case RotationData::CENTER:
|
|
case RotationData::TOPCENTER:
|
|
case RotationData::BOTTOMCENTER:
|
|
case RotationData::BASELINECENTER:
|
|
os << 'c';
|
|
break;
|
|
case RotationData::TOPRIGHT:
|
|
case RotationData::BOTTOMRIGHT:
|
|
case RotationData::BASELINERIGHT:
|
|
os << 'r';
|
|
break;
|
|
}
|
|
|
|
return os;
|
|
}
|
|
|
|
} // namespace
|
|
|
|
|
|
string const RotationLatexCommand::front_impl() const
|
|
{
|
|
if (data.no_rotation())
|
|
return string();
|
|
|
|
ostringstream os;
|
|
os << "\\rotatebox";
|
|
|
|
if (data.origin() != RotationData::DEFAULT)
|
|
os << "[origin=" << data.origin() << ']';
|
|
|
|
os << '{' << data.angle << "}{";
|
|
return os.str();
|
|
}
|
|
|
|
|
|
string const RotationLatexCommand::back_impl() const
|
|
{
|
|
if (data.no_rotation())
|
|
return string();
|
|
|
|
return "}";
|
|
}
|
|
|
|
|
|
string const ClipLatexOption::option_impl() const
|
|
{
|
|
if (!data.clip || data.bbox.empty())
|
|
return string();
|
|
|
|
ostringstream os;
|
|
if (!data.bbox.empty())
|
|
os << "bb=" << data.bbox.xl.asLatexString() << ' '
|
|
<< data.bbox.yb.asLatexString() << ' '
|
|
<< data.bbox.xr.asLatexString() << ' '
|
|
<< data.bbox.yt.asLatexString() << ',';
|
|
if (data.clip)
|
|
os << "clip,";
|
|
return os.str();
|
|
}
|
|
|
|
|
|
string const ResizeLatexOption::option_impl() const
|
|
{
|
|
if (data.no_resize())
|
|
return string();
|
|
|
|
ostringstream os;
|
|
if (data.usingScale()) {
|
|
double const scl = convert<double>(data.scale);
|
|
if (!float_equal(scl, 100.0, 0.05))
|
|
os << "scale=" << scl / 100.0 << ',';
|
|
return os.str();
|
|
}
|
|
|
|
if (!data.width.zero())
|
|
os << "width=" << data.width.asLatexString() << ',';
|
|
if (!data.height.zero())
|
|
os << "height=" << data.height.asLatexString() << ',';
|
|
if (data.keepAspectRatio)
|
|
os << "keepaspectratio,";
|
|
|
|
return os.str();
|
|
}
|
|
|
|
|
|
string const RotationLatexOption ::option_impl() const
|
|
{
|
|
if (data.no_rotation())
|
|
return string();
|
|
|
|
ostringstream os;
|
|
os << "angle=" << data.angle << ',';
|
|
|
|
if (data.origin() != RotationData::DEFAULT)
|
|
os << "origin=" << data.origin() << ',';
|
|
|
|
return os.str();
|
|
}
|
|
|
|
|
|
string const sanitizeDocBookOption(string const & input)
|
|
{
|
|
return input;
|
|
}
|
|
|
|
|
|
string const sanitizeLatexOption(string const & input)
|
|
{
|
|
string::const_iterator begin = input.begin();
|
|
string::const_iterator end = input.end();
|
|
string::const_iterator it = begin;
|
|
|
|
// Strip any leading commas
|
|
// "[,,,,foo..." -> "foo..." ("foo..." may be empty)
|
|
string output;
|
|
lyx::smatch what;
|
|
static lyx::regex const front("^( *\\[,*)(.*)$");
|
|
|
|
if (!regex_match(it, end, what, front)) {
|
|
lyxerr << "Unable to sanitize LaTeX \"Option\": "
|
|
<< input << '\n';
|
|
return string();
|
|
}
|
|
it = what[1].second;
|
|
|
|
// Replace any consecutive commas with a single one
|
|
// "foo,,,,bar" -> "foo,bar"
|
|
// with iterator now pointing to 'b'
|
|
static lyx::regex const commas("([^,]*)(,,*)(.*)$");
|
|
for (; it != end;) {
|
|
if (!regex_match(it, end, what, commas)) {
|
|
output += string(it, end);
|
|
break;
|
|
}
|
|
output += what.str(1) + ",";
|
|
it = what[3].first;
|
|
}
|
|
|
|
// Strip any trailing commas
|
|
// "...foo,,,]" -> "...foo" ("...foo,,," may be empty)
|
|
static lyx::regex const back("^(.*[^,])?,*\\] *$");
|
|
if (!regex_match(output, what, back)) {
|
|
lyxerr << "Unable to sanitize LaTeX \"Option\": "
|
|
<< output << '\n';
|
|
return string();
|
|
}
|
|
output = what.str(1);
|
|
|
|
// Remove any surrounding whitespace
|
|
output = trim(output);
|
|
|
|
// If the thing is empty, leave it so, else wrap it in square brackets.
|
|
return output.empty() ? output : "[" + output + "]";
|
|
}
|
|
|
|
|
|
namespace {
|
|
|
|
template <typename Factory, typename Data, typename Transformer>
|
|
void extractIt(boost::any const & any_factory,
|
|
Data const & data, Transformer & transformer)
|
|
{
|
|
if (any_factory.type() != typeid(Factory))
|
|
return;
|
|
|
|
Factory factory = boost::any_cast<Factory>(any_factory);
|
|
if (factory)
|
|
transformer = factory(data);
|
|
}
|
|
|
|
} // namespace
|
|
|
|
|
|
TransformCommand::ptr_type
|
|
TransformStore::getCommandTransformer(RotationData const & data) const
|
|
{
|
|
TransformCommand::ptr_type ptr;
|
|
if (id == Rotate)
|
|
extractIt<RotationCommandFactory>(any_factory, data, ptr);
|
|
return ptr;
|
|
}
|
|
|
|
|
|
TransformCommand::ptr_type
|
|
TransformStore::getCommandTransformer(ResizeData const & data) const
|
|
{
|
|
TransformCommand::ptr_type ptr;
|
|
if (id == Resize)
|
|
extractIt<ResizeCommandFactory>(any_factory, data, ptr);
|
|
return ptr;
|
|
}
|
|
|
|
|
|
TransformOption::ptr_type
|
|
TransformStore::getOptionTransformer(RotationData const & data) const
|
|
{
|
|
TransformOption::ptr_type ptr;
|
|
if (id == Rotate)
|
|
extractIt<RotationOptionFactory>(any_factory, data, ptr);
|
|
return ptr;
|
|
}
|
|
|
|
|
|
TransformOption::ptr_type
|
|
TransformStore::getOptionTransformer(ResizeData const & data) const
|
|
{
|
|
TransformOption::ptr_type ptr;
|
|
if (id == Resize)
|
|
extractIt<ResizeOptionFactory>(any_factory, data, ptr);
|
|
return ptr;
|
|
}
|
|
|
|
|
|
TransformOption::ptr_type
|
|
TransformStore::getOptionTransformer(ClipData const & data) const
|
|
{
|
|
TransformOption::ptr_type ptr;
|
|
if (id == Clip)
|
|
extractIt<ClipOptionFactory>(any_factory, data, ptr);
|
|
return ptr;
|
|
}
|
|
|
|
|
|
|
|
TransformOption::ptr_type
|
|
TransformStore::getOptionTransformer(string const & data) const
|
|
{
|
|
TransformOption::ptr_type ptr;
|
|
if (id == Extra)
|
|
extractIt<ExtraOptionFactory>(any_factory, data, ptr);
|
|
return ptr;
|
|
}
|
|
|
|
|
|
namespace {
|
|
|
|
OriginTranslator const initOriginTranslator()
|
|
{
|
|
OriginTranslator translator(RotationData::DEFAULT, "default");
|
|
translator.addPair(RotationData::TOPLEFT, "topleft");
|
|
translator.addPair(RotationData::BOTTOMLEFT, "bottomleft");
|
|
translator.addPair(RotationData::BASELINELEFT, "baselineleft");
|
|
translator.addPair(RotationData::CENTER, "center");
|
|
translator.addPair(RotationData::TOPCENTER, "topcenter");
|
|
translator.addPair(RotationData::BOTTOMCENTER, "bottomcenter");
|
|
translator.addPair(RotationData::BASELINECENTER, "baselinecenter");
|
|
translator.addPair(RotationData::TOPRIGHT, "topright");
|
|
translator.addPair(RotationData::BOTTOMRIGHT, "bottomright");
|
|
translator.addPair(RotationData::BASELINERIGHT, "baselineright");
|
|
return translator;
|
|
}
|
|
|
|
|
|
OriginTranslator const & originTranslator()
|
|
{
|
|
static OriginTranslator const translator = initOriginTranslator();
|
|
return translator;
|
|
}
|
|
|
|
} // namespace
|
|
|
|
} // namespace external
|
|
} // namespace lyx
|