Document NeedCProtect -1

[lyx.git] / src / buffer_funcs.h

diff --git a/src/buffer_funcs.h b/src/buffer_funcs.h
index db433142ece6cbefb54f2fac51d81f052ef897f4..7d0bd07f84294d24fe6e9c18bd4773aa369aa24c 100644 (file)
--- a/src/buffer_funcs.h
+++ b/src/buffer_funcs.h
@@ -3,7 +3,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Alfredo Braunstein
  *
  * Full author contact details are available in file CREDITS.
@@ -14,33 +14,36 @@
 
 #include <string>
 
+namespace lyx {
+
+namespace support { class FileName; }
 
 class Buffer;
-class DocIterator;
-class ErrorList;
-class TeXErrors;
 
 /**
- *  Loads a LyX file \c filename into \c Buffer
- *  and \return success status.
+ *  Checks and loads a LyX file \param filename.
+ *  \retval the newly created \c Buffer pointer if successful or 0.
+ *  \retval 0 if the \c Buffer could not be created.
  */
-bool loadLyXFile(Buffer *, std::string const & filename);
+Buffer * checkAndLoadLyXFile(support::FileName const & filename,
+               bool acceptDirty = false);
 
-/* Make a new file (buffer) with name \c filename based on a template
- * named \c templatename
+/** Make a new file (buffer) with name \c filename based on a template
+ *  named \c templatename
  */
 Buffer * newFile(std::string const & filename, std::string const & templatename,
                 bool isNamed = false);
 
-///return the format of the buffer on a string
-std::string const BufferFormat(Buffer const & buffer);
-///
-void bufferErrors(Buffer const &, TeXErrors const &);
-///
-void bufferErrors(Buffer const &, ErrorList const &);
+/** Make a new unnamed file (buffer) with prefix \c prefix
+ *  based on a template named \c templatename
+ */
+Buffer * newUnnamedFile(support::FileName const & path,
+       std::string const & prefix, std::string const & templatename = "");
 
-/// Count the number of words in the text between these two iterators
-int countWords(DocIterator const & from, DocIterator const & to);
+/// Load the file with name \c fname, and returns the buffer. If the
+/// file was already loaded it just returns the associated buffer.
+Buffer * loadIfNeeded(support::FileName const & fname);
 
+} // namespace lyx
 
 #endif // BUFFER_FUNCS_H