anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-06 11:23:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
cd94180492
lyx_mirror/src/texstream.h

189 lines
4.4 KiB
C
Raw Normal View History

Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
// -*- C++ -*-
/**
* \file texstream.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Enrico Forestieri
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LYX_TEXSTREAM_H
#define LYX_TEXSTREAM_H
#include "support/docstream.h"
Rationalise includes Modifying TexRow.h or texstream.h no longer triggers the recompilation of the complete source tree.
2016-06-19 02:39:38 +00:00
#include "support/unique_ptr.h"
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
namespace lyx {
Rationalise includes Modifying TexRow.h or texstream.h no longer triggers the recompilation of the complete source tree.
2016-06-19 02:39:38 +00:00
class TexRow;
Some compilers are worried that a struct is not the same as a class
2016-10-17 22:54:37 +00:00
struct TexString;
Rationalise includes Modifying TexRow.h or texstream.h no longer triggers the recompilation of the complete source tree.
2016-06-19 02:39:38 +00:00
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
/** Wrapper class for odocstream.
This class is used to automatically count the lines of the exported latex
Splitting otexstream into otexrowstream and otexstream. otexstream used to count lines to build a TexRow, and some other things. The new class otexrowstream has the line counting feature of the previous otexstream without other stuff. otexstream is now a subclass of otexrowstream that has the same features as before. This is preliminary work for extending the cursor<->row tracking to math.
2015-10-07 03:02:40 +00:00
code.
*/
class otexrowstream {
public:
///
Remove option to disable texrow I suspect that the gain was negligible, yet it made debugging and maintainance harder.
2016-09-04 02:02:47 +00:00
explicit otexrowstream(odocstream & os);
Rationalise includes Modifying TexRow.h or texstream.h no longer triggers the recompilation of the complete source tree.
2016-06-19 02:39:38 +00:00
/// defaulted
~otexrowstream();
Splitting otexstream into otexrowstream and otexstream. otexstream used to count lines to build a TexRow, and some other things. The new class otexrowstream has the line counting feature of the previous otexstream without other stuff. otexstream is now a subclass of otexrowstream that has the same features as before. This is preliminary work for extending the cursor<->row tracking to math.
2015-10-07 03:02:40 +00:00
///
odocstream & os() { return os_; }
///
Rationalise includes Modifying TexRow.h or texstream.h no longer triggers the recompilation of the complete source tree.
2016-06-19 02:39:38 +00:00
TexRow & texrow() { return *texrow_; }
///
Amend 670efa8f Lost in rebasing.
2016-07-04 02:43:22 +00:00
unique_ptr<TexRow> releaseTexRow();
Splitting otexstream into otexrowstream and otexstream. otexstream used to count lines to build a TexRow, and some other things. The new class otexrowstream has the line counting feature of the previous otexstream without other stuff. otexstream is now a subclass of otexrowstream that has the same features as before. This is preliminary work for extending the cursor<->row tracking to math.
2015-10-07 03:02:40 +00:00
///
void put(char_type const & c);
Add cursor<->row correspondance tracking for tables and subcaptions. Please use the new function otexstream.append(str, texrow) to append an odocstringstream with texrow information to the output when outputing to a string buffer (e.g. case of subcaptions).
2015-10-13 22:51:50 +00:00
///
texstring and otexstringstream texstring is a pair of a docstring and a corresponding TexRow. The row count in the TexRow has to match the number of lines in the docstring. otexstringstream is an output string stream that can be used to create texstrings (i.e. it's an odocstringstream that records the TexRow information and let us extract a texstring from it). texstrings can be passed around and output to otexstream and otexrowstream, which produces an accurate TexRow information by concatenating TexRows.
2016-09-04 02:21:19 +00:00
void append(TexString ts);
Splitting otexstream into otexrowstream and otexstream. otexstream used to count lines to build a TexRow, and some other things. The new class otexrowstream has the line counting feature of the previous otexstream without other stuff. otexstream is now a subclass of otexrowstream that has the same features as before. This is preliminary work for extending the cursor<->row tracking to math.
2015-10-07 03:02:40 +00:00
private:
///
odocstream & os_;
///
Rationalise includes Modifying TexRow.h or texstream.h no longer triggers the recompilation of the complete source tree.
2016-06-19 02:39:38 +00:00
unique_ptr<TexRow> texrow_;
Splitting otexstream into otexrowstream and otexstream. otexstream used to count lines to build a TexRow, and some other things. The new class otexrowstream has the line counting feature of the previous otexstream without other stuff. otexstream is now a subclass of otexrowstream that has the same features as before. This is preliminary work for extending the cursor<->row tracking to math.
2015-10-07 03:02:40 +00:00
};
///
otexrowstream & operator<<(otexrowstream &, odocstream_manip);
///
texstring and otexstringstream texstring is a pair of a docstring and a corresponding TexRow. The row count in the TexRow has to match the number of lines in the docstring. otexstringstream is an output string stream that can be used to create texstrings (i.e. it's an odocstringstream that records the TexRow information and let us extract a texstring from it). texstrings can be passed around and output to otexstream and otexrowstream, which produces an accurate TexRow information by concatenating TexRows.
2016-09-04 02:21:19 +00:00
otexrowstream & operator<<(otexrowstream &, TexString);
///
Splitting otexstream into otexrowstream and otexstream. otexstream used to count lines to build a TexRow, and some other things. The new class otexrowstream has the line counting feature of the previous otexstream without other stuff. otexstream is now a subclass of otexrowstream that has the same features as before. This is preliminary work for extending the cursor<->row tracking to math.
2015-10-07 03:02:40 +00:00
otexrowstream & operator<<(otexrowstream &, docstring const &);
///
otexrowstream & operator<<(otexrowstream &, std::string const &);
///
otexrowstream & operator<<(otexrowstream &, char const *);
///
otexrowstream & operator<<(otexrowstream &, char);
///
template <typename Type>
otexrowstream & operator<<(otexrowstream & ots, Type value);
/** Subclass for otexrowstream.
This class is used to ensure that no blank lines may be inadvertently output.
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
To this end, use the special variables "breakln" and "safebreakln" as if
they were iomanip's to ensure that the next output will start at the
beginning of a line. Using "breakln", a '\n' char will be output if needed,
while using "safebreakln", "%\n" will be output if needed.
The class also records the last output character and can tell whether
a paragraph break was just output.
*/
Splitting otexstream into otexrowstream and otexstream. otexstream used to count lines to build a TexRow, and some other things. The new class otexrowstream has the line counting feature of the previous otexstream without other stuff. otexstream is now a subclass of otexrowstream that has the same features as before. This is preliminary work for extending the cursor<->row tracking to math.
2015-10-07 03:02:40 +00:00
class otexstream : public otexrowstream {
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
public:
///
Remove option to disable texrow I suspect that the gain was negligible, yet it made debugging and maintainance harder.
2016-09-04 02:02:47 +00:00
explicit otexstream(odocstream & os)
: otexrowstream(os), canbreakline_(false),
texstream: implement way to terminate a command depending on the context i.e., * space if non terminating char follows * {} if space follows * nothing if \, { or } follow
2016-12-12 14:55:28 +00:00
protectspace_(false), terminate_command_(false),
parbreak_(true), lastchar_(0) {}
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
///
void put(char_type const & c);
///
texstring and otexstringstream texstring is a pair of a docstring and a corresponding TexRow. The row count in the TexRow has to match the number of lines in the docstring. otexstringstream is an output string stream that can be used to create texstrings (i.e. it's an odocstringstream that records the TexRow information and let us extract a texstring from it). texstrings can be passed around and output to otexstream and otexrowstream, which produces an accurate TexRow information by concatenating TexRows.
2016-09-04 02:21:19 +00:00
void append(TexString ts);
///
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
void canBreakLine(bool breakline) { canbreakline_ = breakline; }
///
bool canBreakLine() const { return canbreakline_; }
///
void protectSpace(bool protectspace) { protectspace_ = protectspace; }
///
bool protectSpace() const { return protectspace_; }
///
texstream: implement way to terminate a command depending on the context i.e., * space if non terminating char follows * {} if space follows * nothing if \, { or } follow
2016-12-12 14:55:28 +00:00
void terminateCommand(bool terminate) { terminate_command_ = terminate; }
///
bool terminateCommand() const { return terminate_command_; }
///
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
void lastChar(char_type const & c)
{
parbreak_ = (!canbreakline_ && c == '\n');
canbreakline_ = (c != '\n');
lastchar_ = c;
}
///
char_type lastChar() const { return lastchar_; }
///
bool afterParbreak() const { return parbreak_; }
private:
///
bool canbreakline_;
///
bool protectspace_;
///
texstream: implement way to terminate a command depending on the context i.e., * space if non terminating char follows * {} if space follows * nothing if \, { or } follow
2016-12-12 14:55:28 +00:00
bool terminate_command_;
///
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
bool parbreak_;
///
char_type lastchar_;
};
texstring and otexstringstream texstring is a pair of a docstring and a corresponding TexRow. The row count in the TexRow has to match the number of lines in the docstring. otexstringstream is an output string stream that can be used to create texstrings (i.e. it's an odocstringstream that records the TexRow information and let us extract a texstring from it). texstrings can be passed around and output to otexstream and otexrowstream, which produces an accurate TexRow information by concatenating TexRows.
2016-09-04 02:21:19 +00:00
/// because we need to pass ods_ to the base class
struct otexstringstream_helper { odocstringstream ods_; };
/// otexstringstream : a odocstringstream with tex/row correspondence
class otexstringstream : otexstringstream_helper, public otexstream {
public:
otexstringstream() : otexstringstream_helper(), otexstream(ods_) {}
///
docstring str() const { return ods_.str(); }
///
size_t length();
///
bool empty() { return 0 == length(); }
/// move-returns the contents and reset the texstream
TexString release();
};
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
/// Helper structs for breaking a line
struct BreakLine {
char n;
};
struct SafeBreakLine {
char n;
};
texstream: implement way to terminate a command depending on the context i.e., * space if non terminating char follows * {} if space follows * nothing if \, { or } follow
2016-12-12 14:55:28 +00:00
/// Helper structs for terminating a command
struct TerminateCommand {
char n;
};
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
extern BreakLine breakln;
extern SafeBreakLine safebreakln;
texstream: implement way to terminate a command depending on the context i.e., * space if non terminating char follows * {} if space follows * nothing if \, { or } follow
2016-12-12 14:55:28 +00:00
extern TerminateCommand termcmd;
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
///
otexstream & operator<<(otexstream &, BreakLine);
///
otexstream & operator<<(otexstream &, SafeBreakLine);
///
texstream: implement way to terminate a command depending on the context i.e., * space if non terminating char follows * {} if space follows * nothing if \, { or } follow
2016-12-12 14:55:28 +00:00
otexstream & operator<<(otexstream &, TerminateCommand);
///
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
otexstream & operator<<(otexstream &, odocstream_manip);
///
texstring and otexstringstream texstring is a pair of a docstring and a corresponding TexRow. The row count in the TexRow has to match the number of lines in the docstring. otexstringstream is an output string stream that can be used to create texstrings (i.e. it's an odocstringstream that records the TexRow information and let us extract a texstring from it). texstrings can be passed around and output to otexstream and otexrowstream, which produces an accurate TexRow information by concatenating TexRows.
2016-09-04 02:21:19 +00:00
otexstream & operator<<(otexstream &, TexString);
///
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
otexstream & operator<<(otexstream &, docstring const &);
///
otexstream & operator<<(otexstream &, std::string const &);
///
otexstream & operator<<(otexstream &, char const *);
///
otexstream & operator<<(otexstream &, char);
///
template <typename Type>
otexstream & operator<<(otexstream & ots, Type value);
Rationalise includes Modifying TexRow.h or texstream.h no longer triggers the recompilation of the complete source tree.
2016-06-19 02:39:38 +00:00
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 lyx
Move otexstream out of support This resolves a dependency of src/support/docstream.cpp on src/TexRow.cpp, which is the wrong way round. This fixes the linking src/tests/check_ExternalTransforms with MSVC where the linker is not clever enough to detect that the whole otexstream class is unused.
2015-01-09 20:07:59 +00:00
#endif
Reference in New Issue Copy Permalink