lyx_mirror/src/tex2lyx/tex2lyx.cpp
Jean-Marc Lasgouttes 28f43b1896 Now tex2lyx is able to set the encoding from what it reads in the preamble.
What works:
- parsing of inputenc should work
- \inputencoding is acted on in the preamble

What does not work:
- \inputencoding in the text
- all the corner cases I have not considered, and all buggy stuff in the
  'what works' paragraph
- InsetLatexAccent are still created, but I do not know when they got added
to the code.

The only notable trick in the code is that I had to disable buffering. Otherwise
the whole text was read before I had a chance to change the encoding...

Finally I remove the artificial limitation that forbid
  \usepackage[opt1,opt2]{package1,package2}



git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@27592 a592a061-630c-0410-9148-cb99ea01b6c8
2008-11-16 21:51:18 +00:00

558 lines
13 KiB
C++

/**
* \file tex2lyx.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 "tex2lyx.h"
#include "Context.h"
#include "Encoding.h"
#include "Layout.h"
#include "TextClass.h"
#include "support/convert.h"
#include "support/debug.h"
#include "support/ExceptionMessage.h"
#include "support/filetools.h"
#include "support/lassert.h"
#include "support/lstrings.h"
#include "support/os.h"
#include "support/Package.h"
#include <cstdlib>
#include <iostream>
#include <string>
#include <sstream>
#include <vector>
#include <map>
using namespace std;
using namespace lyx::support;
using namespace lyx::support::os;
namespace lyx {
string const trim(string const & a, char const * p)
{
// LASSERT(p, /**/);
if (a.empty() || !*p)
return a;
size_t r = a.find_last_not_of(p);
size_t l = a.find_first_not_of(p);
// Is this the minimal test? (lgb)
if (r == string::npos && l == string::npos)
return string();
return a.substr(l, r - l + 1);
}
void split(string const & s, vector<string> & result, char delim)
{
//cerr << "split 1: '" << s << "'\n";
istringstream is(s);
string t;
while (getline(is, t, delim))
result.push_back(t);
//cerr << "split 2\n";
}
string join(vector<string> const & input, char const * delim)
{
ostringstream os;
for (size_t i = 0; i != input.size(); ++i) {
if (i)
os << delim;
os << input[i];
}
return os.str();
}
char const * const * is_known(string const & str, char const * const * what)
{
for ( ; *what; ++what)
if (str == *what)
return what;
return 0;
}
// current stack of nested environments
vector<string> active_environments;
string active_environment()
{
return active_environments.empty() ? string() : active_environments.back();
}
CommandMap known_commands;
CommandMap known_environments;
CommandMap known_math_environments;
void add_known_command(string const & command, string const & o1,
bool o2)
{
// We have to handle the following cases:
// definition o1 o2 invocation result
// \newcommand{\foo}{bar} "" false \foo bar
// \newcommand{\foo}[1]{bar #1} "[1]" false \foo{x} bar x
// \newcommand{\foo}[1][]{bar #1} "[1]" true \foo bar
// \newcommand{\foo}[1][]{bar #1} "[1]" true \foo[x] bar x
// \newcommand{\foo}[1][x]{bar #1} "[1]" true \foo[x] bar x
unsigned int nargs = 0;
vector<ArgumentType> arguments;
string const opt1 = rtrim(ltrim(o1, "["), "]");
if (isStrUnsignedInt(opt1)) {
// The command has arguments
nargs = convert<unsigned int>(opt1);
if (nargs > 0 && o2) {
// The first argument is optional
arguments.push_back(optional);
--nargs;
}
}
for (unsigned int i = 0; i < nargs; ++i)
arguments.push_back(required);
known_commands[command] = arguments;
}
bool noweb_mode = false;
namespace {
/*!
* Read one command definition from the syntax file
*/
void read_command(Parser & p, string command, CommandMap & commands)
{
if (p.next_token().asInput() == "*") {
p.get_token();
command += '*';
}
vector<ArgumentType> arguments;
while (p.next_token().cat() == catBegin ||
p.next_token().asInput() == "[") {
if (p.next_token().cat() == catBegin) {
string const arg = p.getArg('{', '}');
if (arg == "translate")
arguments.push_back(required);
else
arguments.push_back(verbatim);
} else {
p.getArg('[', ']');
arguments.push_back(optional);
}
}
commands[command] = arguments;
}
/*!
* Read a class of environments from the syntax file
*/
void read_environment(Parser & p, string const & begin,
CommandMap & environments)
{
string environment;
while (p.good()) {
Token const & t = p.get_token();
if (t.cat() == catLetter)
environment += t.asInput();
else if (!environment.empty()) {
p.putback();
read_command(p, environment, environments);
environment.erase();
}
if (t.cat() == catEscape && t.asInput() == "\\end") {
string const end = p.getArg('{', '}');
if (end == begin)
return;
}
}
}
/*!
* Read a list of TeX commands from a reLyX compatible syntax file.
* Since this list is used after all commands that have a LyX counterpart
* are handled, it does not matter that the "syntax.default" file
* has almost all of them listed. For the same reason the reLyX-specific
* reLyXre environment is ignored.
*/
void read_syntaxfile(FileName const & file_name)
{
ifdocstream is(file_name.toFilesystemEncoding().c_str());
if (!is.good()) {
cerr << "Could not open syntax file \"" << file_name
<< "\" for reading." << endl;
exit(2);
}
// We can use our TeX parser, since the syntax of the layout file is
// modeled after TeX.
// Unknown tokens are just silently ignored, this helps us to skip some
// reLyX specific things.
Parser p(is);
while (p.good()) {
Token const & t = p.get_token();
if (t.cat() == catEscape) {
string const command = t.asInput();
if (command == "\\begin") {
string const name = p.getArg('{', '}');
if (name == "environments" || name == "reLyXre")
// We understand "reLyXre", but it is
// not as powerful as "environments".
read_environment(p, name,
known_environments);
else if (name == "mathenvironments")
read_environment(p, name,
known_math_environments);
} else {
read_command(p, command, known_commands);
}
}
}
}
string documentclass;
string syntaxfile;
bool overwrite_files = false;
/// return the number of arguments consumed
typedef int (*cmd_helper)(string const &, string const &);
int parse_help(string const &, string const &)
{
cerr << "Usage: tex2lyx [ command line switches ] <infile.tex> [<outfile.lyx>]\n"
"Command line switches (case sensitive):\n"
"\t-help summarize tex2lyx usage\n"
"\t-f Force creation of .lyx files even if they exist already\n"
"\t-userdir dir try to set user directory to dir\n"
"\t-sysdir dir try to set system directory to dir\n"
"\t-c textclass declare the textclass\n"
"\t-n translate a noweb (aka literate programming) file.\n"
"\t-s syntaxfile read additional syntax file" << endl;
exit(0);
}
int parse_class(string const & arg, string const &)
{
if (arg.empty()) {
cerr << "Missing textclass string after -c switch" << endl;
exit(1);
}
documentclass = arg;
return 1;
}
int parse_syntaxfile(string const & arg, string const &)
{
if (arg.empty()) {
cerr << "Missing syntaxfile string after -s switch" << endl;
exit(1);
}
syntaxfile = internal_path(arg);
return 1;
}
// Filled with the command line arguments "foo" of "-sysdir foo" or
// "-userdir foo".
string cl_system_support;
string cl_user_support;
int parse_sysdir(string const & arg, string const &)
{
if (arg.empty()) {
cerr << "Missing directory for -sysdir switch" << endl;
exit(1);
}
cl_system_support = internal_path(arg);
return 1;
}
int parse_userdir(string const & arg, string const &)
{
if (arg.empty()) {
cerr << "Missing directory for -userdir switch" << endl;
exit(1);
}
cl_user_support = internal_path(arg);
return 1;
}
int parse_force(string const &, string const &)
{
overwrite_files = true;
return 0;
}
int parse_noweb(string const &, string const &)
{
noweb_mode = true;
return 0;
}
void easyParse(int & argc, char * argv[])
{
map<string, cmd_helper> cmdmap;
cmdmap["-c"] = parse_class;
cmdmap["-f"] = parse_force;
cmdmap["-s"] = parse_syntaxfile;
cmdmap["-help"] = parse_help;
cmdmap["--help"] = parse_help;
cmdmap["-n"] = parse_noweb;
cmdmap["-sysdir"] = parse_sysdir;
cmdmap["-userdir"] = parse_userdir;
for (int i = 1; i < argc; ++i) {
map<string, cmd_helper>::const_iterator it
= cmdmap.find(argv[i]);
// don't complain if not found - may be parsed later
if (it == cmdmap.end())
continue;
string arg(to_utf8(from_local8bit((i + 1 < argc) ? argv[i + 1] : "")));
string arg2(to_utf8(from_local8bit((i + 2 < argc) ? argv[i + 2] : "")));
int const remove = 1 + it->second(arg, arg2);
// Now, remove used arguments by shifting
// the following ones remove places down.
argc -= remove;
for (int j = i; j < argc; ++j)
argv[j] = argv[j + remove];
--i;
}
}
// path of the first parsed file
string masterFilePath;
// path of the currently parsed file
string parentFilePath;
} // anonymous namespace
string getMasterFilePath()
{
return masterFilePath;
}
string getParentFilePath()
{
return parentFilePath;
}
namespace {
/*!
* Reads tex input from \a is and writes lyx output to \a os.
* Uses some common settings for the preamble, so this should only
* be used more than once for included documents.
* Caution: Overwrites the existing preamble settings if the new document
* contains a preamble.
* You must ensure that \p parentFilePath is properly set before calling
* this function!
*/
void tex2lyx(idocstream & is, ostream & os)
{
Parser p(is);
//p.dump();
stringstream ss;
TeX2LyXDocClass textclass;
parse_preamble(p, ss, documentclass, textclass);
active_environments.push_back("document");
Context context(true, textclass);
parse_text(p, ss, FLAG_END, true, context);
if (Context::empty)
// Empty document body. LyX needs at least one paragraph.
context.check_layout(ss);
context.check_end_layout(ss);
ss << "\n\\end_body\n\\end_document\n";
active_environments.pop_back();
ss.seekg(0);
os << ss.str();
#ifdef TEST_PARSER
p.reset();
ofdocstream parsertest("parsertest.tex");
while (p.good())
parsertest << p.get_token().asInput();
// <origfile> and parsertest.tex should now have identical content
#endif
}
/// convert TeX from \p infilename to LyX and write it to \p os
bool tex2lyx(FileName const & infilename, ostream & os)
{
ifdocstream is;
// forbid buffering on this stream
is.rdbuf()->pubsetbuf(0,0);
is.open(infilename.toFilesystemEncoding().c_str());
if (!is.good()) {
cerr << "Could not open input file \"" << infilename
<< "\" for reading." << endl;
return false;
}
string const oldParentFilePath = parentFilePath;
parentFilePath = onlyPath(infilename.absFilename());
tex2lyx(is, os);
parentFilePath = oldParentFilePath;
return true;
}
} // anonymous namespace
bool tex2lyx(string const & infilename, FileName const & outfilename)
{
if (outfilename.isReadableFile()) {
if (overwrite_files) {
cerr << "Overwriting existing file "
<< outfilename << endl;
} else {
cerr << "Not overwriting existing file "
<< outfilename << endl;
return false;
}
} else {
cerr << "Creating file " << outfilename << endl;
}
ofstream os(outfilename.toFilesystemEncoding().c_str());
if (!os.good()) {
cerr << "Could not open output file \"" << outfilename
<< "\" for writing." << endl;
return false;
}
#ifdef FILEDEBUG
cerr << "Input file: " << infilename << "\n";
cerr << "Output file: " << outfilename << "\n";
#endif
return tex2lyx(FileName(infilename), os);
}
} // namespace lyx
int main(int argc, char * argv[])
{
using namespace lyx;
//setlocale(LC_CTYPE, "");
lyxerr.setStream(cerr);
easyParse(argc, argv);
if (argc <= 1) {
cerr << "Usage: tex2lyx [ command line switches ] <infile.tex> [<outfile.lyx>]\n"
"See tex2lyx -help." << endl;
return 2;
}
os::init(argc, argv);
try {
init_package(internal_path(to_utf8(from_local8bit(argv[0]))),
cl_system_support, cl_user_support,
top_build_dir_is_two_levels_up);
} catch (ExceptionMessage const & message) {
cerr << to_utf8(message.title_) << ":\n"
<< to_utf8(message.details_) << endl;
if (message.type_ == ErrorException)
exit(1);
}
// Now every known option is parsed. Look for input and output
// file name (the latter is optional).
string infilename = internal_path(to_utf8(from_local8bit(argv[1])));
infilename = makeAbsPath(infilename).absFilename();
string outfilename;
if (argc > 2) {
outfilename = internal_path(to_utf8(from_local8bit(argv[2])));
if (outfilename != "-")
outfilename = makeAbsPath(outfilename).absFilename();
} else
outfilename = changeExtension(infilename, ".lyx");
// Read the syntax tables
FileName const system_syntaxfile = libFileSearch("", "syntax.default");
if (system_syntaxfile.empty()) {
cerr << "Error: Could not find syntax file \"syntax.default\"." << endl;
exit(1);
}
read_syntaxfile(system_syntaxfile);
if (!syntaxfile.empty())
read_syntaxfile(makeAbsPath(syntaxfile));
// Read the encodings table.
FileName const symbols_path = libFileSearch(string(), "unicodesymbols");
if (symbols_path.empty()) {
cerr << "Error: Could not find file \"unicodesymbols\"."
<< endl;
exit(1);
}
FileName const enc_path = libFileSearch(string(), "encodings");
if (enc_path.empty()) {
cerr << "Error: Could not find file \"encodings\"."
<< endl;
exit(1);
}
encodings.read(enc_path, symbols_path);
// The real work now.
masterFilePath = onlyPath(infilename);
parentFilePath = masterFilePath;
if (outfilename == "-") {
if (tex2lyx(FileName(infilename), cout))
return EXIT_SUCCESS;
else
return EXIT_FAILURE;
} else {
if (tex2lyx(infilename, FileName(outfilename)))
return EXIT_SUCCESS;
else
return EXIT_FAILURE;
}
}
// }])