lyx_mirror/src/mathed/MathAutoCorrect.cpp

197 lines
3.7 KiB
C++
Raw Normal View History

/**
* \file MathAutoCorrect.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "Cursor.h"
#include "MathAutoCorrect.h"
#include "MathData.h"
#include "InsetMath.h"
#include "MathSupport.h"
#include "MathParser.h"
#include "support/debug.h"
#include "support/FileName.h"
#include "support/filetools.h" // LibFileSearch
#include "support/docstream.h"
#include <fstream>
#include <sstream>
using namespace std;
namespace lyx {
using support::libFileSearch;
namespace {
class Correction {
public:
///
2016-06-12 03:47:54 +00:00
/// \brief Correction
2017-03-02 13:47:31 +00:00
Correction() : from2_(0) {}
///
bool correct(Cursor & cur, char_type c) const;
///
bool read(idocstream & is);
///
void write(odocstream & os) const;
private:
///
MathData from1_;
///
char_type from2_;
///
MathData to_;
};
bool Correction::read(idocstream & is)
{
docstring s1, s2, s3;
is >> s1 >> s2 >> s3;
if (!is)
return false;
if (s2.size() != 1)
return false;
MathData ar1, ar3;
mathed_parse_cell(ar1, s1);
mathed_parse_cell(ar3, s3);
from1_ = ar1;
from2_ = s2[0];
to_ = ar3;
return true;
}
bool Correction::correct(Cursor & cur, char_type c) const
{
//LYXERR(Debug::MATHED,
// "trying to correct ar: " << at << " from: '" << from1_ << '\'');
if (from2_ != c)
return false;
pos_type n = from1_.size();
if (cur.pos() < pos_type(from1_.size())) // not enough to match
return false;
pos_type start = cur.pos() - from1_.size();
for (pos_type i = 0; i < n; i++)
if (asString(cur.cell()[start + i]) != asString(from1_[i]))
return false;
LYXERR(Debug::MATHED, "match found! subst in " << cur.cell()
<< " from: '" << from1_ << "' to '" << to_ << '\'');
cur.cell().erase(cur.pos() - n, cur.pos());
cur.pos() -= n;
cur.insert(to_);
return true;
}
#if 0
void Correction::write(odocstream & os) const
{
os << "from: '" << from1_ << "' and '" << from2_
<< "' to '" << to_ << '\'' << endl;
}
idocstream & operator>>(idocstream & is, Correction & corr)
{
corr.read(is);
return is;
}
odocstream & operator<<(odocstream & os, Correction & corr)
{
corr.write(os);
return os;
}
#endif
class Corrections {
public:
///
typedef vector<Correction>::const_iterator const_iterator;
///
Corrections() {}
///
void insert(const Correction & corr) { data_.push_back(corr); }
///
bool correct(Cursor & cur, char_type c) const;
private:
///
vector<Correction> data_;
};
bool Corrections::correct(Cursor & cur, char_type c) const
{
for (const_iterator it = data_.begin(); it != data_.end(); ++it)
if (it->correct(cur, c))
return true;
return false;
}
Corrections theCorrections;
void initAutoCorrect()
{
LYXERR(Debug::MATHED, "reading autocorrect file");
support::FileName const file = libFileSearch(string(), "autocorrect");
if (file.empty()) {
lyxerr << "Could not find autocorrect file" << endl;
return;
}
string line;
ifstream is(file.toFilesystemEncoding().c_str());
while (getline(is, line)) {
if (line.empty() || line[0] == '#') {
//LYXERR(Debug::MATHED, "ignoring line '" << line << '\'');
continue;
}
idocstringstream il(from_utf8(line));
//LYXERR(Debug::MATHED, "line '" << line << '\'');
Correction corr;
if (corr.read(il)) {
//LYXERR(Debug::MATHED, "parsed: '" << corr << '\'');
theCorrections.insert(corr);
}
}
LYXERR(Debug::MATHED, "done reading autocorrections.");
}
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 11:11:54 +00:00
} // namespace
bool math_autocorrect(Cursor & cur, char_type c)
{
static bool initialized = false;
if (!initialized) {
initAutoCorrect();
initialized = true;
}
return theCorrections.correct(cur, c);
}
} // namespace lyx