]> git.lyx.org Git - lyx.git/blobdiff - src/converter.h
Add GTK bibitem dialog
[lyx.git] / src / converter.h
index d9d823abcddd21f190ddd9fce500bbdd82e9012f..f5f66ed810eddb1c9caf77c99bf25ef01c6c34bc 100644 (file)
 // -*- 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 <vector>
-#include <queue>
-#include "LString.h"
-#include "support/lstrings.h"
-
-class Buffer;
-
-///
-class Format {
-public:
-       ///
-       Format(string const & n, string const & e, string const & p,
-              string const & s, string const & v) :
-               name_(n), extension_(e), prettyname_(p), shortcut_(s),
-               viewer_(v) {};
-       ///
-       bool dummy() const;
-       ///
-       bool IsChildFormat() const;
-       ///
-       string const ParentFormat() const;
-       ///
-       string const & name() const {
-               return name_;
-       }
-       ///
-       string const & extension() const {
-               return extension_;
-       }
-       ///
-       string const & prettyname() const {
-               return prettyname_;
-       }
-       ///
-       string const & shortcut() const {
-               return shortcut_;
-       }
-       ///
-       string const & viewer() const {
-               return viewer_;
-       }
-       ///
-       void setViewer(string const & v) {
-               viewer_ = v;
-       }
-private:
-       string name_;
-       ///
-       string extension_;
-       ///
-       string prettyname_;
-       ///
-       string shortcut_;
-       ///
-       string viewer_;
-};
-
-
-inline
-bool operator<(Format const & a, Format const & b)
-{
-       return compare_no_case(a.prettyname(),b.prettyname()) < 0;
-}
+#include <string>
 
 
-///
-class Formats {
-public:
-        ///
-        typedef std::vector<Format> FormatList;
-       ///
-       typedef FormatList::const_iterator const_iterator;
-       ///
-       Format const & Get(int i) const {
-               return formatlist[i];
-       }
-       ///
-       Format const * GetFormat(string const & name) const;
-       ///
-       int GetNumber(string const & name) const;
-       ///
-       void Add(string const & name);
-       ///
-       void Add(string const & name, string const & extension, 
-                string const & prettyname, string const & shortcut);
-       ///
-       void Delete(string const & name);
-       ///
-       void Sort();
-       ///
-       void SetViewer(string const & name, string const & command);
-       ///
-       bool View(Buffer const * buffer, string const & filename,
-                 string const & format_name) const;
-       ///
-       string const PrettyName(string const & name) const;
-       ///
-       string const Extension(string const & name) const;
-       ///
-       const_iterator begin() const {
-               return formatlist.begin();
-       }
-       ///
-       const_iterator end() const {
-               return formatlist.end();
-       }
-       ///
-       FormatList::size_type size() const {
-               return formatlist.size();
-       }
-private:
-       ///
-       FormatList formatlist;
-};
+class Buffer;
+class Format;
+class Formats;
+class OutputParams;
 
-///////////////////////////////////////////////////////////////////////
 
 ///
 class Converter {
 public:
        ///
-       Converter(string const & f, string const & t, string const & c,
-                 string const & l)
-               : from(f), to(t), command(c), flags(l), From(0), To(0),
-                 latex(false), original_dir(false), need_aux(false) {}
+       Converter(std::string const & f, std::string const & t, std::string const & c,
+                 std::string const & l);
        ///
-       void ReadFlags();
+       void readFlags();
        ///
-       string from;
+       std::string from;
        ///
-       string to;
+       std::string to;
        ///
-       string command;
+       std::string command;
        ///
-       string flags;
+       std::string flags;
        ///
        Format const * From;
        ///
@@ -158,120 +48,111 @@ public:
 
        /// 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;
+       std::string result_file;
        /// Command to convert the program output to a LaTeX log file format
-       string parselog;
+       std::string parselog;
 };
 
 
 ///
 class Converters {
 public:
-        typedef std::vector<Converter> ConverterList;
        ///
-       typedef ConverterList::const_iterator const_iterator;
+       typedef std::vector<int> EdgePath; // to be removed SOON
        ///
-       typedef std::vector<int> EdgePath;
+       typedef std::vector<Converter> ConverterList;
        ///
-       Converter const & Get(int i) const {
-               return converterlist[i];
+       typedef ConverterList::const_iterator const_iterator;
+       ///
+       Converter const & get(int i) const {
+               return converterlist_[i];
        }
        ///
-       Converter const * GetConverter(string const & from, string const & to);
+       Converter const * getConverter(std::string const & from,
+                                      std::string const & to) const;
        ///
-       int GetNumber(string const & from, string const & to);
+       int getNumber(std::string const & from, std::string const & to) const;
        ///
-       void Add(string const & from, string const & to,
-                string const & command, string const & flags);
+       void add(std::string const & from, std::string const & to,
+                std::string const & command, std::string const & flags);
        //
-       void Delete(string const & from, string const & to);
+       void erase(std::string const & from, std::string const & to);
        ///
-       void Sort();
+       void sort();
        ///
        std::vector<Format const *> const
-       GetReachableTo(string const & target, bool clear_visited);
+       getReachableTo(std::string const & target, bool clear_visited);
        ///
        std::vector<Format const *> const
-       GetReachable(string const & from, bool only_viewable,
+       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);
        ///
-       bool IsReachable(string const & from, string const & to);
-       ///
-       EdgePath const GetPath(string const & from, string const & to);
-       ///
-       bool UsePdflatex(EdgePath const & path);
-       ///
-       bool Convert(Buffer const * buffer,
-                    string const & from_file, string const & to_file_base,
-                    string const & from_format, string const & to_format,
-                    string & to_file);
+       Graph::EdgePath const getPath(std::string const & from, std::string const & to);
        ///
-       bool Convert(Buffer const * buffer,
-                    string const & from_file, string const & to_file_base,
-                    string const & from_format, string const & to_format);
+       OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path);
        ///
-       string const papersize(Buffer const * buffer);
+       bool convert(Buffer const * buffer,
+                    std::string const & from_file, std::string const & to_file_base,
+                    std::string const & from_format, std::string const & to_format,
+                     std::string & to_file, bool try_default = false);
        ///
-       string const dvips_options(Buffer const * buffer);
+       bool convert(Buffer const * buffer,
+                    std::string const & from_file, std::string const & to_file_base,
+                    std::string const & from_format, std::string const & to_format,
+                     bool try_default = false);
        ///
-       string const dvipdfm_options(Buffer const * buffer);
+       void update(Formats const & formats);
        ///
-       void Update(Formats const & formats);
+       void updateLast(Formats const & formats);
        ///
-       void UpdateLast(Formats const & formats);
-       ///
-       void BuildGraph();
-       ///
-       bool FormatIsUsed(string const & format);
+       bool formatIsUsed(std::string const & format);
        ///
        const_iterator begin() const {
-               return converterlist.begin();
+               return converterlist_.begin();
        }
        const_iterator end() const {
-               return converterlist.end();
+               return converterlist_.end();
        }
-private:
-       ///
-       bool scanLog(Buffer const * buffer, string const & command, 
-                    string const & filename);
        ///
-       bool runLaTeX(Buffer const * buffer, string const & command);
-       ///
-       ConverterList converterlist;
-       ///
-       string latex_command;
+       void buildGraph();
+private:
        ///
-       struct Vertex {
-               std::vector<int> in_vertices;
-               std::vector<int> out_vertices;
-               std::vector<int> out_edges;
-       };
+       std::vector<Format const *> const
+       intToFormat(std::vector<int> const & input);
        ///
-       static
-       std::vector<Vertex> vertices;
+       bool scanLog(Buffer const & buffer, std::string const & command,
+                    std::string const & filename);
        ///
-       std::vector<bool> visited;
+       bool runLaTeX(Buffer const & buffer, std::string const & command,
+                     OutputParams const &);
        ///
-       std::queue<int> Q;
+       ConverterList converterlist_;
        ///
-       int BFS_init(string const & start, bool clear_visited = true);
+       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,
+                 std::string const & from, std::string const & to,
+                 bool copy);
        ///
-       bool Move(string const & from, string const & to, bool copy);
+       Graph G_;
 };
 
-extern Formats formats;
 extern Converters converters;
 
-extern Formats system_formats;
 extern Converters system_converters;
 
-#endif
+#endif //CONVERTER_H