// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+/**
+ * \file converter.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ====================================================== */
+ * \author Dekel Tsur
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef CONVERTER_H
#define CONVERTER_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "graph.h"
+#include "outputparams.h"
-#include <map>
#include <vector>
-#include "LString.h"
+#include <string>
+
+
+namespace lyx {
+
+namespace support { class FileName; }
class Buffer;
+class ErrorList;
+class Format;
+class Formats;
+class OutputParams;
+
///
-struct Command {
+class Converter {
+public:
+ ///
+ Converter(std::string const & f, std::string const & t, std::string const & c,
+ std::string const & l);
///
- Command(string const & f, string const & t, string const & c)
- : from(f), to(t), command(c),
- original_dir(false), need_aux(false) {}
+ void readFlags();
///
- string from;
+ std::string from;
///
- string to;
+ std::string to;
///
- string command;
+ std::string command;
+ ///
+ std::string flags;
+ ///
+ Format const * From;
+ ///
+ Format const * To;
+
+ /// The converter is latex or its derivatives
+ bool latex;
+ /// The converter is xml
+ bool xml;
/// Do we need to run the converter in the original directory?
bool original_dir;
/// This converter needs the .aux files
bool need_aux;
/// If the converter put the result in a directory, then result_dir
/// is the name of the directory
- string result_dir;
+ std::string result_dir;
/// If the converter put the result in a directory, then result_file
/// is the name of the main file in that directory
- string result_file;
- ///
- bool visited;
- ///
- std::vector<Command>::iterator previous;
+ std::string result_file;
+ /// Command to convert the program output to a LaTeX log file format
+ std::string parselog;
};
+
///
-class Format {
+class Converters {
public:
///
- Format() : in_degree(0) {}
+ typedef std::vector<int> EdgePath; // to be removed SOON
///
- Format(string const & n);
+ typedef std::vector<Converter> ConverterList;
///
- string name;
+ typedef ConverterList::const_iterator const_iterator;
///
- string prettyname;
+ Converter const & get(int i) const {
+ return converterlist_[i];
+ }
///
- string viewer;
+ Converter const * getConverter(std::string const & from,
+ std::string const & to) const;
///
- int in_degree;
-};
-
-///
-class Formats {
-public:
+ int getNumber(std::string const & from, std::string const & to) const;
///
- static
- void Add(string const & name);
+ void add(std::string const & from, std::string const & to,
+ std::string const & command, std::string const & flags);
+ //
+ void erase(std::string const & from, std::string const & to);
///
- static
- void SetViewer(string const & name, string const & command);
+ void sort();
///
- static
- bool View(Buffer * buffer, string const & filename);
+ std::vector<Format const *> const
+ getReachableTo(std::string const & target, bool clear_visited);
///
- static
- Format * GetFormat(string const & name);
+ std::vector<Format const *> const
+ getReachable(std::string const & from, bool only_viewable,
+ bool clear_visited);
+ /// Does a conversion path from format \p from to format \p to exist?
+ bool isReachable(std::string const & from, std::string const & to);
///
- static
- string const PrettyName(string const & name);
-private:
+ Graph::EdgePath const getPath(std::string const & from, std::string const & to);
///
- static
- std::map<string, Format> formats;
-};
-
-///
-class Converter {
-public:
+ OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path);
+ /// Flags for converting files
+ enum ConversionFlags {
+ /// No special flags
+ none = 0,
+ /// Use the default converter if no converter is defined
+ try_default = 1 << 0,
+ /// Get the converted file from cache if possible
+ try_cache = 1 << 1
+ };
+ ///
+ bool convert(Buffer const * buffer,
+ support::FileName const & from_file, support::FileName const & to_file,
+ support::FileName const & orig_from,
+ std::string const & from_format, std::string const & to_format,
+ ErrorList & errorList, int conversionflags = none);
///
- static
- void Add(string const & from, string const & to,
- string const & command, string const & flags);
+ void update(Formats const & formats);
///
- static
- std::vector<std::pair<string, string> > const
- GetReachable(string const & from,
- bool only_viewable = false);
+ void updateLast(Formats const & formats);
///
- static
- bool Convert(Buffer * buffer, string const & from_file,
- string const & to_file, string const & using_format,
- string * view_file = 0);
- static
- string const SplitFormat(string const & str, string & format);
+ bool formatIsUsed(std::string const & format);
///
- static
- string dvi_papersize(Buffer * buffer);
+ const_iterator begin() const {
+ return converterlist_.begin();
+ }
+ const_iterator end() const {
+ return converterlist_.end();
+ }
///
- static
- string dvips_options(Buffer * buffer);
+ void buildGraph();
private:
///
- static
- bool runLaTeX(Buffer * buffer, string const & command);
+ std::vector<Format const *> const
+ intToFormat(std::vector<int> const & input);
+ ///
+ bool scanLog(Buffer const & buffer, std::string const & command,
+ support::FileName const & filename, ErrorList & errorList);
+ ///
+ bool runLaTeX(Buffer const & buffer, std::string const & command,
+ OutputParams const &, ErrorList & errorList);
///
- static
- std::vector<Command> commands;
+ ConverterList converterlist_;
///
- static
- string latex_command;
+ std::string latex_command_;
+ /// If \p from = /path/file.ext and \p to = /path2/file2.ext2 then
+ /// this method moves each /path/file*.ext file to /path2/file2*.ext2
+ bool move(std::string const & fmt,
+ support::FileName const & from, support::FileName const & to,
+ bool copy);
+ ///
+ Graph G_;
};
-#endif
+/// The global instance.
+/// Implementation is in lyx_main.C.
+extern Converters & theConverters();
+
+/// The global copy after reading lyxrc.defaults.
+/// Implementation is in lyx_main.C.
+extern Converters & theSystemConverters();
+
+} // namespace lyx
+
+#endif //CONVERTER_H