mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-19 22:40:26 +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.
376 lines
9.7 KiB
C++
376 lines
9.7 KiB
C++
/**
|
|
* \file output_docbook.cpp
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author José Matos
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#include <config.h>
|
|
|
|
#include "output_docbook.h"
|
|
|
|
#include "Buffer.h"
|
|
#include "buffer_funcs.h"
|
|
#include "BufferParams.h"
|
|
#include "Counters.h"
|
|
#include "Font.h"
|
|
#include "Layout.h"
|
|
#include "OutputParams.h"
|
|
#include "Paragraph.h"
|
|
#include "ParagraphList.h"
|
|
#include "ParagraphParameters.h"
|
|
#include "sgml.h"
|
|
#include "Text.h"
|
|
#include "TextClass.h"
|
|
|
|
#include "support/lassert.h"
|
|
#include "support/debug.h"
|
|
#include "support/lstrings.h"
|
|
#include "support/lyxalgo.h"
|
|
|
|
#include <iostream>
|
|
|
|
using namespace std;
|
|
using namespace lyx::support;
|
|
|
|
namespace lyx {
|
|
|
|
namespace {
|
|
|
|
ParagraphList::const_iterator searchParagraph(
|
|
ParagraphList::const_iterator p,
|
|
ParagraphList::const_iterator const & pend)
|
|
{
|
|
for (++p; p != pend && p->layout().latextype == LATEX_PARAGRAPH; ++p)
|
|
;
|
|
|
|
return p;
|
|
}
|
|
|
|
|
|
ParagraphList::const_iterator searchCommand(
|
|
ParagraphList::const_iterator p,
|
|
ParagraphList::const_iterator const & pend)
|
|
{
|
|
Layout const & bstyle = p->layout();
|
|
|
|
for (++p; p != pend; ++p) {
|
|
Layout const & style = p->layout();
|
|
if (style.latextype == LATEX_COMMAND
|
|
&& style.commanddepth <= bstyle.commanddepth)
|
|
return p;
|
|
}
|
|
return pend;
|
|
}
|
|
|
|
|
|
ParagraphList::const_iterator searchEnvironment(
|
|
ParagraphList::const_iterator p,
|
|
ParagraphList::const_iterator const & pend)
|
|
{
|
|
Layout const & bstyle = p->layout();
|
|
size_t const depth = p->params().depth();
|
|
for (++p; p != pend; ++p) {
|
|
Layout const & style = p->layout();
|
|
if (style.latextype == LATEX_COMMAND)
|
|
return p;
|
|
|
|
if (style.latextype == LATEX_PARAGRAPH) {
|
|
if (p->params().depth() > depth)
|
|
continue;
|
|
return p;
|
|
}
|
|
|
|
if (p->params().depth() < depth)
|
|
return p;
|
|
|
|
if (style.latexname() != bstyle.latexname()
|
|
&& p->params().depth() == depth)
|
|
return p;
|
|
}
|
|
return pend;
|
|
}
|
|
|
|
|
|
ParagraphList::const_iterator makeParagraph(
|
|
Buffer const & buf,
|
|
odocstream & os,
|
|
OutputParams const & runparams,
|
|
Text const & text,
|
|
ParagraphList::const_iterator const & pbegin,
|
|
ParagraphList::const_iterator const & pend)
|
|
{
|
|
ParagraphList const & paragraphs = text.paragraphs();
|
|
for (ParagraphList::const_iterator par = pbegin; par != pend; ++par) {
|
|
if (par != pbegin)
|
|
os << '\n';
|
|
bool const default_or_plain =
|
|
(buf.params().documentClass().isDefaultLayout(par->layout())
|
|
|| buf.params().documentClass().isPlainLayout(par->layout()));
|
|
if (default_or_plain && par->emptyTag()) {
|
|
par->simpleDocBookOnePar(buf, os, runparams,
|
|
text.outerFont(distance(paragraphs.begin(), par)));
|
|
} else {
|
|
sgml::openTag(buf, os, runparams, *par);
|
|
par->simpleDocBookOnePar(buf, os, runparams,
|
|
text.outerFont(distance(paragraphs.begin(), par)));
|
|
sgml::closeTag(os, *par);
|
|
}
|
|
}
|
|
return pend;
|
|
}
|
|
|
|
|
|
ParagraphList::const_iterator makeEnvironment(
|
|
Buffer const & buf,
|
|
odocstream & os,
|
|
OutputParams const & runparams,
|
|
Text const & text,
|
|
ParagraphList::const_iterator const & pbegin,
|
|
ParagraphList::const_iterator const & pend)
|
|
{
|
|
ParagraphList const & paragraphs = text.paragraphs();
|
|
ParagraphList::const_iterator par = pbegin;
|
|
|
|
Layout const & defaultstyle = buf.params().documentClass().defaultLayout();
|
|
Layout const & bstyle = par->layout();
|
|
|
|
// Opening outter tag
|
|
sgml::openTag(buf, os, runparams, *pbegin);
|
|
os << '\n';
|
|
if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
|
|
os << "<![CDATA[";
|
|
|
|
while (par != pend) {
|
|
Layout const & style = par->layout();
|
|
ParagraphList::const_iterator send;
|
|
string id = par->getID(buf, runparams);
|
|
string wrapper = "";
|
|
pos_type sep = 0;
|
|
|
|
// Opening inner tag
|
|
switch (bstyle.latextype) {
|
|
case LATEX_ENVIRONMENT:
|
|
if (!bstyle.innertag().empty()) {
|
|
sgml::openTag(os, bstyle.innertag(), id);
|
|
}
|
|
break;
|
|
|
|
case LATEX_ITEM_ENVIRONMENT:
|
|
if (!bstyle.labeltag().empty()) {
|
|
sgml::openTag(os, bstyle.innertag(), id);
|
|
sgml::openTag(os, bstyle.labeltag());
|
|
sep = par->firstWordDocBook(os, runparams) + 1;
|
|
sgml::closeTag(os, bstyle.labeltag());
|
|
}
|
|
wrapper = defaultstyle.latexname();
|
|
// If a sub list (embedded list) appears next with a
|
|
// different depth, then there is no need to open
|
|
// another tag at the current depth.
|
|
if(par->params().depth() == pbegin->params().depth()) {
|
|
sgml::openTag(os, bstyle.itemtag());
|
|
}
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
switch (style.latextype) {
|
|
case LATEX_ENVIRONMENT:
|
|
case LATEX_ITEM_ENVIRONMENT: {
|
|
if (par->params().depth() == pbegin->params().depth()) {
|
|
sgml::openTag(os, wrapper);
|
|
par->simpleDocBookOnePar(buf, os, runparams,
|
|
text.outerFont(distance(paragraphs.begin(), par)), sep);
|
|
sgml::closeTag(os, wrapper);
|
|
++par;
|
|
}
|
|
else {
|
|
send = searchEnvironment(par, pend);
|
|
par = makeEnvironment(buf, os, runparams, text, par,send);
|
|
}
|
|
break;
|
|
}
|
|
case LATEX_PARAGRAPH:
|
|
send = searchParagraph(par, pend);
|
|
par = makeParagraph(buf, os, runparams, text, par,send);
|
|
break;
|
|
case LATEX_LIST_ENVIRONMENT:
|
|
case LATEX_BIB_ENVIRONMENT:
|
|
case LATEX_COMMAND:
|
|
// FIXME This means that we are just skipping any paragraph that
|
|
// isn't implemented above, and this includes lists.
|
|
++par;
|
|
break;
|
|
}
|
|
|
|
// Closing inner tag
|
|
switch (bstyle.latextype) {
|
|
case LATEX_ENVIRONMENT:
|
|
if (!bstyle.innertag().empty()) {
|
|
sgml::closeTag(os, bstyle.innertag());
|
|
os << '\n';
|
|
}
|
|
break;
|
|
case LATEX_ITEM_ENVIRONMENT:
|
|
// If a sub list (embedded list) appears next, then
|
|
// there is no need to close the current tag.
|
|
// par should have already been incremented to the next
|
|
// element. So we can compare the depth of the next
|
|
// element with pbegin.
|
|
// We need to be careful, that we don't dereference par
|
|
// when par == pend but at the same time that the
|
|
// current tag is closed.
|
|
if((par != pend && par->params().depth() == pbegin->params().depth()) || par == pend) {
|
|
sgml::closeTag(os, bstyle.itemtag());
|
|
}
|
|
if (!bstyle.labeltag().empty())
|
|
sgml::closeTag(os, bstyle.innertag());
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (bstyle.latextype == LATEX_ENVIRONMENT && bstyle.pass_thru)
|
|
os << "]]>";
|
|
|
|
// Closing outer tag
|
|
sgml::closeTag(os, *pbegin);
|
|
|
|
return pend;
|
|
}
|
|
|
|
|
|
ParagraphList::const_iterator makeCommand(
|
|
Buffer const & buf,
|
|
odocstream & os,
|
|
OutputParams const & runparams,
|
|
Text const & text,
|
|
ParagraphList::const_iterator const & pbegin,
|
|
ParagraphList::const_iterator const & pend)
|
|
{
|
|
ParagraphList const & paragraphs = text.paragraphs();
|
|
ParagraphList::const_iterator par = pbegin;
|
|
Layout const & bstyle = par->layout();
|
|
|
|
//Open outter tag
|
|
sgml::openTag(buf, os, runparams, *pbegin);
|
|
os << '\n';
|
|
|
|
// Label around sectioning number:
|
|
if (!bstyle.labeltag().empty()) {
|
|
sgml::openTag(os, bstyle.labeltag());
|
|
// We don't care about appendix in DOCBOOK.
|
|
os << par->expandDocBookLabel(bstyle, buf.params());
|
|
sgml::closeTag(os, bstyle.labeltag());
|
|
}
|
|
|
|
// Opend inner tag and close inner tags
|
|
sgml::openTag(os, bstyle.innertag());
|
|
par->simpleDocBookOnePar(buf, os, runparams,
|
|
text.outerFont(distance(paragraphs.begin(), par)));
|
|
sgml::closeTag(os, bstyle.innertag());
|
|
os << '\n';
|
|
|
|
++par;
|
|
while (par != pend) {
|
|
Layout const & style = par->layout();
|
|
ParagraphList::const_iterator send;
|
|
|
|
switch (style.latextype) {
|
|
case LATEX_COMMAND: {
|
|
send = searchCommand(par, pend);
|
|
par = makeCommand(buf, os, runparams, text, par,send);
|
|
break;
|
|
}
|
|
case LATEX_ENVIRONMENT:
|
|
case LATEX_ITEM_ENVIRONMENT: {
|
|
send = searchEnvironment(par, pend);
|
|
par = makeEnvironment(buf, os, runparams, text, par,send);
|
|
break;
|
|
}
|
|
case LATEX_PARAGRAPH:
|
|
send = searchParagraph(par, pend);
|
|
par = makeParagraph(buf, os, runparams, text, par,send);
|
|
break;
|
|
case LATEX_BIB_ENVIRONMENT:
|
|
case LATEX_LIST_ENVIRONMENT:
|
|
// FIXME This means that we are just skipping any paragraph that
|
|
// isn't implemented above.
|
|
++par;
|
|
break;
|
|
}
|
|
}
|
|
// Close outter tag
|
|
sgml::closeTag(os, *pbegin);
|
|
|
|
return pend;
|
|
}
|
|
|
|
} // namespace
|
|
|
|
|
|
void docbookParagraphs(Text const & text,
|
|
Buffer const & buf,
|
|
odocstream & os,
|
|
OutputParams const & runparams)
|
|
{
|
|
LASSERT(runparams.par_begin <= runparams.par_end,
|
|
{ os << "<!-- Docbook Output Error -->\n"; return; });
|
|
|
|
ParagraphList const & paragraphs = text.paragraphs();
|
|
ParagraphList::const_iterator par = paragraphs.begin();
|
|
ParagraphList::const_iterator pend = paragraphs.end();
|
|
|
|
// if only part of the paragraphs will be outputed
|
|
if (runparams.par_begin != runparams.par_end) {
|
|
par = lyx::next(paragraphs.begin(), runparams.par_begin);
|
|
pend = lyx::next(paragraphs.begin(), runparams.par_end);
|
|
// runparams will be passed to nested paragraphs, so
|
|
// we have to reset the range parameters.
|
|
const_cast<OutputParams&>(runparams).par_begin = 0;
|
|
const_cast<OutputParams&>(runparams).par_end = 0;
|
|
}
|
|
|
|
while (par != pend) {
|
|
Layout const & style = par->layout();
|
|
ParagraphList::const_iterator lastpar = par;
|
|
ParagraphList::const_iterator send;
|
|
|
|
switch (style.latextype) {
|
|
case LATEX_COMMAND: {
|
|
send = searchCommand(par, pend);
|
|
par = makeCommand(buf, os, runparams, text, par, send);
|
|
break;
|
|
}
|
|
case LATEX_ENVIRONMENT:
|
|
case LATEX_ITEM_ENVIRONMENT: {
|
|
send = searchEnvironment(par, pend);
|
|
par = makeEnvironment(buf, os, runparams, text, par, send);
|
|
break;
|
|
}
|
|
case LATEX_PARAGRAPH:
|
|
send = searchParagraph(par, pend);
|
|
par = makeParagraph(buf, os, runparams, text, par, send);
|
|
break;
|
|
case LATEX_BIB_ENVIRONMENT:
|
|
case LATEX_LIST_ENVIRONMENT:
|
|
// FIXME This means that we are just skipping any paragraph that
|
|
// isn't implemented above.
|
|
++par;
|
|
break;
|
|
}
|
|
// makeEnvironment may process more than one paragraphs and bypass pend
|
|
if (distance(lastpar, par) >= distance(lastpar, pend))
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
} // namespace lyx
|