]> git.lyx.org Git - lyx.git/blobdiff - src/buffer_funcs.h
SCons: msvc does not need this /TP option any more after we rename .C => .cpp. Also...
[lyx.git] / src / buffer_funcs.h
index d2453780e35eef96dc5db0e21ba6652d2749aeee..b2142f81185f9ae6590632c11e68ef916f27055d 100644 (file)
 #define BUFFER_FUNCS_H
 
 #include "lyxlayout_ptr_fwd.h"
+#include "support/docstring.h"
 
 #include <string>
 
 
+namespace lyx {
+
+namespace support { class FileName; }
+
 class Buffer;
 class DocIterator;
 class ErrorList;
 class TeXErrors;
 class ParIterator;
 
+
+/** 
+ * Returns true if the file is already loaded into a buffer.
+ */
+bool checkIfLoaded(support::FileName const & fn);
+
 /**
  *  Loads a LyX file \c filename into \c Buffer
  *  and \return success status.
  */
-bool loadLyXFile(Buffer *, std::string const & filename);
+bool loadLyXFile(Buffer *, support::FileName const & filename);
 
-/* Make a new file (buffer) with name \c filename based on a template
- * named \c templatename
+/**
+ *  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.
+ */
+Buffer * checkAndLoadLyXFile(support::FileName const & filename);
+
+/** 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 &);
+
+/// Fill in the ErrorList with the TeXErrors
+void bufferErrors(Buffer const &, TeXErrors const &, ErrorList &);
 
 /// Count the number of words in the text between these two iterators
 int countWords(DocIterator const & from, DocIterator const & to);
 
-/// Expand the counters for the labelstring of \c layout
-std::string expandLabel(Buffer const & buf, LyXLayout_ptr const & layout,
-                       bool appendix);
+/// updates all counters
+void updateLabels(Buffer const &, bool childonly = false);
 
-/// updates current counter and/or label if possible.
-/**
-\retval true if a full updateCounters is required.
-\retval false if a full updateCounters is not required.
-*/
-bool needsUpdateCounters(Buffer const & buf, ParIterator & it);
+///
+void updateLabels(Buffer const &, ParIterator &);
 
-/// updates all counters
-void updateCounters(Buffer const &);
+///
+void checkBufferStructure(Buffer &, ParIterator const &);
+
+///
+void loadChildDocuments(Buffer const & buffer);
 
+} // namespace lyx
 
 #endif // BUFFER_FUNCS_H