src/insets/insetexternal.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetexternal.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup Nielsen
   8  *
   9  * Full author contact details are available in file CREDITS
  10  */
  11
  12 #ifndef INSET_EXTERNAL_H
  13 #define INSET_EXTERNAL_H
  14
  15 #include "insetbutton.h"
  16 #include "ExternalTemplate.h"
  17 #include "LString.h"
  18
  19 ///
  20 class InsetExternal : public InsetButton {
  21 public:
  22         /// hold parameters settable from the GUI
  23         struct Params {
  24                 Params(string const & f = string(),
  25                                         string const & p = string(),
  26                                         ExternalTemplate const & t = ExternalTemplate())
  27                         : filename(f), parameters(p), templ(t) {}
  28                 /// the filename
  29                 string filename;
  30                 /// the parameters of the current choice
  31                 string parameters;
  32                 /// the current template used
  33                 ExternalTemplate templ;
  34         };
  35
  36         InsetExternal();
  37         ///
  38         virtual ~InsetExternal();
  39         ///
  40         virtual dispatch_result localDispatch(FuncRequest const & cmd);
  41         /// what appears in the minibuffer when opening
  42         virtual string const editMessage() const;
  43         ///
  44         virtual EDITABLE editable() const { return IS_EDITABLE; }
  45         ///
  46         virtual void write(Buffer const *, std::ostream &) const;
  47         ///
  48         virtual void read(Buffer const *, LyXLex & lex);
  49
  50         /** returns the number of rows (\n's) of generated tex code.
  51          fragile == true means, that the inset should take care about
  52          fragile commands by adding a \protect before.
  53          If the free_spc (freespacing) variable is set, then this inset
  54          is in a free-spacing paragraph.
  55          */
  56         virtual int latex(Buffer const *, std::ostream &, bool fragile,
  57                           bool free_spc) const;
  58         /// write ASCII output to the ostream
  59         virtual int ascii(Buffer const *, std::ostream &, int linelen) const;
  60         /// write LinuxDoc output to the ostream
  61         virtual int linuxdoc(Buffer const *, std::ostream &) const;
  62         /// write DocBook output to the ostream
  63         virtual int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  64
  65         /// Updates needed features for this inset.
  66         virtual void validate(LaTeXFeatures & features) const;
  67
  68         /// returns LyX code associated with the inset. Used for TOC, ...)
  69         virtual Inset::Code lyxCode() const { return EXTERNAL_CODE; }
  70
  71         ///
  72         virtual Inset * clone(Buffer const &, bool same_id = false) const;
  73
  74         /// returns the text of the button
  75         virtual string const getScreenLabel(Buffer const *) const;
  76
  77         // The following public members are used from the frontends code
  78
  79         /// set the parameters from a Params structure
  80         virtual void setFromParams(Params const &);
  81
  82         ///
  83         void updateExternal() const;
  84
  85         /// update the file represented by the template
  86         void updateExternal(string const &, Buffer const *) const;
  87
  88         /// edit file of this template
  89         void editExternal() const;
  90
  91         /// view file of this template
  92         void viewExternal() const;
  93
  94         /// return a copy of our current params
  95         Params const & params() const;
  96
  97         ///
  98         void setView(BufferView * bv) { view_ = bv; }
  99
 100 private:
 101         /// Write the output for a specific file format
 102         int write(string const & format, Buffer const *,
 103                   std::ostream &) const;
 104
 105         /// Execute this command in the directory of this document
 106         void executeCommand(string const & s, Buffer const * buf) const;
 107
 108         /// Substitute meta-variables in this string
 109         string const doSubstitution(Buffer const *, string const & s) const;
 110
 111         /// our owning view
 112         BufferView * view_;
 113
 114         /// the current params
 115         Params params_;
 116
 117         /// A temp filename
 118         string tempname_;
 119 };
 120
 121
 122 #include "mailinset.h"
 123
 124 class InsetExternalMailer : public MailInset {
 125 public:
 126         ///
 127         InsetExternalMailer(InsetExternal & inset);
 128         ///
 129         virtual InsetBase & inset() const { return inset_; }
 130         ///
 131         virtual string const & name() const { return name_; }
 132         ///
 133         virtual string const inset2string() const;
 134         ///
 135         static void string2params(string const &, InsetExternal::Params &);
 136         ///
 137         static string const params2string(InsetExternal::Params const &);
 138 private:
 139         ///
 140         static string const name_;
 141         ///
 142         InsetExternal & inset_;
 143 };
 144
 145 #endif