#include "OutputEnums.h"
#include "OutputParams.h"
-#include "insets/InsetCode.h"
-
+#include "support/unique_ptr.h"
#include "support/strfwd.h"
#include "support/types.h"
}
namespace support {
+class DocFileName;
class FileName;
class FileNameList;
}
ExportTexPathHasSpaces,
ExportConverterError,
// preview
+ // Implies ExportSuccess.
PreviewSuccess,
+ // The exported file exists but there was an error when opening
+ // it in a viewer.
PreviewError
};
/// read a new document from a string
bool readString(std::string const &);
/// Reloads the LyX file
- /// \param clearUndo if false, leave alone the undo stack.
- ReadStatus reload(bool clearUndo = true);
+ ReadStatus reload();
//FIXME: The following function should be private
//private:
/// read the header, returns number of unknown tokens
int readHeader(Lexer & lex);
+ double fontScalingFactor() const;
+
private:
///
typedef std::map<Buffer const *, Buffer *> BufferMap;
/// of the temporary file to be read
ReadStatus convertLyXFormat(support::FileName const & fn,
support::FileName & tmpfile, int from_format);
+ /// get appropriate name for backing up files from older versions
+ support::FileName getBackupName() const;
//@}
public:
/// It is always an absolute path.
std::string filePath() const;
+ /** Contructs a file name of a referenced file (child doc, included graphics etc).
+ * Absolute names are returned as is. If the name is relative, it is
+ * interpreted relative to filePath() if the file exists, otherwise
+ * relative to the original path where the document was last saved.
+ * The original path may be different from filePath() if the document was
+ * later manually moved to a different location.
+ */
+ support::DocFileName getReferencedFileName(std::string const & fn) const;
+
+ /** Returns the path where a local layout file lives.
+ * An empty string is returned for standard system and user layouts.
+ * If possible, it is always relative to the buffer path.
+ */
+ std::string layoutPos() const;
+
+ /** Set the path to a local layout file.
+ * This must be an absolute path but, if possible, it is always
+ * stored as relative to the buffer path.
+ */
+ void setLayoutPos(std::string const & path);
+
/** A transformed version of the file name, adequate for LaTeX.
\param no_path optional if \c true then the path is stripped.
*/
///
BufferParams & params();
BufferParams const & params() const;
+ ///
+ BufferParams const & masterParams() const;
/** The list of paragraphs.
This is a linked list of paragraph, this list holds the
/// Replace the inset contents for insets which InsetCode is equal
/// to the passed \p inset_code.
- void changeRefsIfUnique(docstring const & from, docstring const & to,
- InsetCode code);
+ void changeRefsIfUnique(docstring const & from, docstring const & to);
/// get source code (latex/docbook) for some paragraphs, or all paragraphs
/// including preamble
- void getSourceCode(odocstream & os, std::string const format,
- pit_type par_begin, pit_type par_end, OutputWhat output,
- bool master) const;
+ /// returns nullptr if Id to Row conversion is unsupported
+ unique_ptr<TexRow> getSourceCode(odocstream & os,
+ std::string const & format, pit_type par_begin,
+ pit_type par_end, OutputWhat output, bool master) const;
/// Access to error list.
/// This method is used only for GUI visualisation of Buffer related
///
ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
- ///
- ExportStatus doExport(std::string const & target, bool put_in_tempdir,
- std::string & result_file) const;
- ///
+ /// Export buffer to format \p format and open the result in a suitable viewer.
+ /// Note: This has nothing to do with preview of graphics or math formulas.
ExportStatus preview(std::string const & format) const;
+ /// true if there was a previous preview this session of this buffer and
+ /// there was an error on the previous preview of this buffer.
+ bool lastPreviewError() const;
private:
+ ///
+ ExportStatus doExport(std::string const & target, bool put_in_tempdir,
+ std::string & result_file) const;
/// target is a format name optionally followed by a space
/// and a destination file-name
ExportStatus doExport(std::string const & target, bool put_in_tempdir,
bool includeall, std::string & result_file) const;
///
- ExportStatus doExport(std::string const & target, bool put_in_tempdir,
- bool includeall) const;
- ///
ExportStatus preview(std::string const & format, bool includeall = false) const;
///
void setMathFlavor(OutputParams & op) const;
///
void checkMasterBuffer();
+ /// If the document is being saved to a new location and the named file
+ /// exists at the old location, return its updated path relative to the
+ /// new buffer path if possible, otherwise return its absolute path.
+ /// In all other cases, this is a no-op and name is returned unchanged.
+ /// If a non-empty ext is given, the existence of name.ext is checked
+ /// but the returned path will not contain this extension.
+ /// Similarly, when loading a document that was moved from the location
+ /// where it was saved, return the correct path relative to the new
+ /// location.
+ std::string includedFilePath(std::string const & name,
+ std::string const & ext = empty_string()) const;
+
/// compute statistics between \p from and \p to
/// \p from initial position
/// \p to points to the end position
int wordCount() const;
int charCount(bool with_blanks) const;
+ // this is const because it does not modify the buffer's real contents,
+ // only the mutable flag.
+ void setChangesPresent(bool) const;
+ bool areChangesPresent() const;
+ void updateChangesPresent() const;
+
private:
friend class MarkAsExporting;
/// mark the buffer as busy exporting something, or not
projects / lyx.git / blobdiff