src/Converter.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Converter.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Dekel Tsur
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef CONVERTER_H
  13 #define CONVERTER_H
  14
  15 #include "Graph.h"
  16 #include "OutputParams.h"
  17
  18 #include <vector>
  19 #include <set>
  20 #include <string>
  21
  22
  23 namespace lyx {
  24
  25 namespace support { class FileName; }
  26
  27 class Buffer;
  28 class ErrorList;
  29 class Format;
  30 class Formats;
  31 class OutputParams;
  32
  33
  34 ///
  35 class Converter {
  36 public:
  37         ///
  38         Converter(std::string const & f, std::string const & t, std::string const & c,
  39                   std::string const & l);
  40         ///
  41         void readFlags();
  42         ///
  43         std::string from;
  44         ///
  45         std::string to;
  46         ///
  47         std::string command;
  48         ///
  49         std::string flags;
  50         ///
  51         Format const * From;
  52         ///
  53         Format const * To;
  54
  55         /// The converter is latex or its derivatives
  56         bool latex;
  57         /// The latex derivate
  58         std::string latex_flavor;
  59         /// The converter is xml
  60         bool xml;
  61         /// This converter needs the .aux files
  62         bool need_aux;
  63         /// we need a "nice" file from the backend, c.f. OutputParams.nice.
  64         bool nice;
  65         /// If the converter put the result in a directory, then result_dir
  66         /// is the name of the directory
  67         std::string result_dir;
  68         /// If the converter put the result in a directory, then result_file
  69         /// is the name of the main file in that directory
  70         std::string result_file;
  71         /// Command to convert the program output to a LaTeX log file format
  72         std::string parselog;
  73 };
  74
  75
  76 ///
  77 class Converters {
  78 public:
  79         ///
  80         typedef std::vector<Converter> ConverterList;
  81         ///
  82         typedef ConverterList::const_iterator const_iterator;
  83         ///
  84         typedef std::vector<std::string> FormatList;
  85
  86         ///
  87         Converter const & get(int i) const { return converterlist_[i]; }
  88         ///
  89         Converter const * getConverter(std::string const & from,
  90                                        std::string const & to) const;
  91         ///
  92         int getNumber(std::string const & from, std::string const & to) const;
  93         ///
  94         void add(std::string const & from, std::string const & to,
  95                  std::string const & command, std::string const & flags);
  96         //
  97         void erase(std::string const & from, std::string const & to);
  98         ///
  99         std::vector<Format const *> const
 100         getReachableTo(std::string const & target, bool clear_visited);
 101         ///
 102         std::vector<Format const *> const
 103         getReachable(std::string const & from, bool only_viewable,
 104                bool clear_visited,
 105                std::set<std::string> const & excludes = std::set<std::string>());
 106
 107         std::vector<Format const *> importableFormats();
 108         std::vector<Format const *> exportableFormats(bool only_viewable);
 109
 110         std::vector<std::string> loaders() const;
 111         std::vector<std::string> savers() const;
 112
 113         /// Does a conversion path from format \p from to format \p to exist?
 114         bool isReachable(std::string const & from, std::string const & to);
 115         ///
 116         Graph::EdgePath getPath(std::string const & from, std::string const & to);
 117         ///
 118         OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path,
 119                                        Buffer const * buffer = 0);
 120         /// Flags for converting files
 121         enum ConversionFlags {
 122                 /// No special flags
 123                 none = 0,
 124                 /// Use the default converter if no converter is defined
 125                 try_default = 1 << 0,
 126                 /// Get the converted file from cache if possible
 127                 try_cache = 1 << 1
 128         };
 129         ///
 130         bool convert(Buffer const * buffer,
 131                      support::FileName const & from_file, support::FileName const & to_file,
 132                      support::FileName const & orig_from,
 133                      std::string const & from_format, std::string const & to_format,
 134                      ErrorList & errorList, int conversionflags = none);
 135         ///
 136         void update(Formats const & formats);
 137         ///
 138         void updateLast(Formats const & formats);
 139         ///
 140         bool formatIsUsed(std::string const & format);
 141         ///
 142         const_iterator begin() const { return converterlist_.begin(); }
 143         ///
 144         const_iterator end() const { return converterlist_.end(); }
 145         ///
 146         void buildGraph();
 147 private:
 148         ///
 149         std::vector<Format const *> const
 150         intToFormat(std::vector<int> const & input);
 151         ///
 152         bool scanLog(Buffer const & buffer, std::string const & command,
 153                      support::FileName const & filename, ErrorList & errorList);
 154         ///
 155         bool runLaTeX(Buffer const & buffer, std::string const & command,
 156                       OutputParams const &, ErrorList & errorList);
 157         ///
 158         ConverterList converterlist_;
 159         ///
 160         std::string latex_command_;
 161         ///
 162         std::string dvilualatex_command_;
 163         ///
 164         std::string lualatex_command_;
 165         ///
 166         std::string pdflatex_command_;
 167         ///
 168         std::string xelatex_command_;
 169         /// If \p from = /path/file.ext and \p to = /path2/file2.ext2 then
 170         /// this method moves each /path/file*.ext file to /path2/file2*.ext2
 171         bool move(std::string const & fmt,
 172                   support::FileName const & from, support::FileName const & to,
 173                   bool copy);
 174         ///
 175         Graph G_;
 176 };
 177
 178 /// The global instance.
 179 /// Implementation is in LyX.cpp.
 180 extern Converters & theConverters();
 181
 182 /// The global copy after reading lyxrc.defaults.
 183 /// Implementation is in LyX.cpp.
 184 extern Converters & theSystemConverters();
 185
 186 } // namespace lyx
 187
 188 #endif //CONVERTER_H