class LyXRC;
class TeXErrors;
class LaTeXFeatures;
-class auto_mem_buffer;
class Language;
///
The is is the buffer object. It contains all the informations about
a document loaded into LyX. I am not sure if the class is complete or
minimal, probably not.
+ \author Lars Gullik Bjønnes
*/
class Buffer {
public:
- /// what type of log will getLogName() return ?
+ /// What type of log will \c getLogName() return?
enum LogType {
- latexlog, /**< LaTeX log */
- buildlog /**< Literate build log */
+ latexlog, ///< LaTeX log
+ buildlog ///< Literate build log
};
- ///
+ /** Constructor
+ \param file
+ \param b optional \c false by default
+ */
explicit Buffer(string const & file, bool b = false);
- ///
+ /// Destrucotr
~Buffer();
- /** save the buffer's parameters as user default
- This function saves a file #user_lyxdir/templates/defaults.lyx#
+ /** Save the buffer's parameters as user default.
+ This function saves a file \c user_lyxdir/templates/defaults.lyx
which parameters are those of the current buffer. This file
is used as a default template when creating a new
- file. Returns #true# on success.
+ file. Returns \c true on success.
*/
bool saveParamsAsDefaults();
/// Maybe we know the function already by number...
bool Dispatch(int ac, string const & argument);
- /// and have an xtl buffer to work with.
- bool Dispatch(int, auto_mem_buffer &);
-
- /// should be changed to work for a list.
+ /// Should be changed to work for a list.
void resize();
- ///
+ ///
void resizeInsets(BufferView *);
- /// Update window titles of all users
+ /// Update window titles of all users.
void updateTitles() const;
- /// Reset autosave timers for all users
+ /// Reset autosave timers for all users.
void resetAutosaveTimers() const;
/** Adds the BufferView to the users list.
- Later this func will insert the #BufferView# into a real list,
+ Later this func will insert the \c BufferView into a real list,
not just setting a pointer.
*/
- void addUser(BufferView * u) { users = u; }
+ void addUser(BufferView * u);
/** Removes the #BufferView# from the users list.
Since we only can have one at the moment, we just reset it.
*/
- void delUser(BufferView *) { users = 0; }
+ void delUser(BufferView *);
///
- void redraw() {
- users->redraw();
- users->fitCursor(users->text);
- //users->updateScrollbar();
- }
+ void redraw();
- ///
+ /// Load the autosaved file.
void loadAutoSaveFile();
/** Reads a file.
- @param par if != 0 insert the file.
- @return #false# if method fails.
+ \param par if != 0 insert the file.
+ \return \c false if method fails.
*/
bool readFile(LyXLex &, LyXParagraph * par = 0);
/** Reads a file without header.
- @param par if != 0 insert the file.
- @return false if file is not completely read.
+ \param par if != 0 insert the file.
+ \return \c false if file is not completely read.
*/
bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
LyXParagraph *& return_par,
string const & token, int & pos,
- char & depth, LyXFont &
-#ifndef NEW_INSETS
- ,LyXParagraph::footnote_flag &,
- LyXParagraph::footnote_kind &
-#endif
- );
+ char & depth, LyXFont &);
private:
/// Parse a single inset.
void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
public:
- /** Save file
+ /** Save file.
Takes care of auto-save files and backup file if requested.
- Returns #true# if the save is successful, #false# otherwise.
+ Returns \c true if the save is successful, \c false otherwise.
*/
bool save() const;
- /// Write file. Returns #false# if unsuccesful.
+ /// Write file. Returns \c false if unsuccesful.
bool writeFile(string const &, bool) const;
///
string const & original_path,
bool nice, bool only_body = false);
/** LaTeX all paragraphs from par to endpar.
- @param endpar if == 0 then to the end
+ \param \a endpar if == 0 then to the end
*/
void latexParagraphs(std::ostream & os, LyXParagraph * par,
LyXParagraph * endpar, TexRow & texrow) const;
bool nice, bool only_body = false);
/// returns the main language for the buffer (document)
- Language const * GetLanguage() const {
- return params.language;
- }
-
+ Language const * GetLanguage() const;
///
- bool isLyxClean() const { return lyx_clean; }
-
+ bool isLyxClean() const;
///
- bool isBakClean() const { return bak_clean; }
-
+ bool isBakClean() const;
///
bool isDepClean(string const & name) const;
///
- void markLyxClean() const {
- if (!lyx_clean) {
- lyx_clean = true;
- updateTitles();
- }
- // if the .lyx file has been saved, we don't need an
- // autosave
- bak_clean = true;
- }
+ void markLyxClean() const;
///
- void markBakClean() { bak_clean = true; }
+ void markBakClean();
///
void markDepClean(string const & name);
///
- void setUnnamed(bool flag=true) { unnamed = flag; }
+ void setUnnamed(bool flag = true);
///
- bool isUnnamed() { return unnamed; }
+ bool isUnnamed();
- ///
- void markDirty() {
- if (lyx_clean) {
- lyx_clean = false;
- updateTitles();
- }
- bak_clean = false;
- DEPCLEAN * tmp = dep_clean;
- while (tmp) {
- tmp->clean = false;
- tmp = tmp->next;
- }
- }
+ /// Mark this buffer as dirty.
+ void markDirty();
- ///
- string const & fileName() const { return filename; }
+ /// Returns the buffers filename.
+ string const & fileName() const;
- /** A transformed version of the file name, adequate for LaTeX
- The path is stripped if no_path is true (default)
+ /** A transformed version of the file name, adequate for LaTeX.
+ \param no_path optional if \c true then the path is stripped.
*/
string const getLatexName(bool no_path = true) const;
- /// get the name and type of the log
- std::pair<LogType, string> const getLogName(void) const;
+ /// Get the name and type of the log.
+ std::pair<LogType, string> const getLogName() const;
/// Change name of buffer. Updates "read-only" flag.
void setFileName(string const & newfile);
void setParentName(string const &);
/// Is buffer read-only?
- bool isReadonly() const { return read_only; }
+ bool isReadonly() const;
/// Set buffer read-only flag
void setReadonly(bool flag = true);
- /// returns #true# if the buffer contains a LaTeX document
+ /// returns \c true if the buffer contains a LaTeX document
bool isLatex() const;
- /// returns #true# if the buffer contains a LinuxDoc document
+ /// returns \c true if the buffer contains a LinuxDoc document
bool isLinuxDoc() const;
- /// returns #true# if the buffer contains a DocBook document
+ /// returns \c true if the buffer contains a DocBook document
bool isDocBook() const;
- /** returns #true# if the buffer contains either a LinuxDoc
+ /** returns \c true if the buffer contains either a LinuxDoc
or DocBook document */
bool isSGML() const;
- /// returns #true# if the buffer contains a Wed document
+ /// returns \c true if the buffer contains a Wed document
bool isLiterate() const;
///
///
string const getIncludeonlyList(char delim = ',');
///
- std::vector<std::pair<string,string> > const getBibkeyList();
+ std::vector<std::pair<string, string> > const getBibkeyList();
///
struct TocItem {
+ TocItem(LyXParagraph * p, int d, string const & s)
+ : par(p), depth(d), str(s) {}
///
LyXParagraph * par;
///
string str;
};
///
- enum TocType {
- ///
- TOC_TOC = 0,
- ///
- TOC_LOF,
- ///
- TOC_LOT,
- ///
- TOC_LOA
- };
+ typedef std::vector<TocItem> SingleList;
+ ///
+ typedef std::map<string, SingleList> Lists;
///
- std::vector<std::vector<TocItem> > const getTocList() const;
+ Lists const getLists() const;
///
std::vector<string> const getLabelList();
/** This will clearly have to change later. Later we can have more
than one user per buffer. */
- BufferView * getUser() const { return users; }
+ BufferView * getUser() const;
///
void ChangeLanguage(Language const * from, Language const * to);
///
BufferParams params;
- /** is a list of paragraphs.
+ /** The list of paragraphs.
+ This is a linked list of paragraph, this list holds the
+ whole contents of the document.
*/
LyXParagraph * paragraph;
- /// RCS object
+ /// LyX version control object.
LyXVC lyxvc;
- /// where the temporaries go if we want them
+ /// Where to put temporary files.
string tmppath;
- ///
+ /// The path to the document file.
string filepath;
- /** While writing as LaTeX, tells whether we are
+ /** If we are writing a nice LaTeX file or not.
+ While writing as LaTeX, tells whether we are
doing a 'nice' LaTeX file */
bool niceFile;
/// Used when typesetting to place errorboxes.
TexRow texrow;
private:
-#ifndef NEW_INSETS
- ///
- void linuxDocHandleFootnote(std::ostream & os,
- LyXParagraph * & par, int depth);
-#endif
///
void DocBookHandleCaption(std::ostream & os, string & inner_tag,
int depth, int desc_on,
LyXParagraph * & par);
-#ifndef NEW_INSETS
- ///
- void DocBookHandleFootnote(std::ostream & os,
- LyXParagraph * & par, int depth);
-#endif
- ///
+ /// Open SGML/XML tag.
void sgmlOpenTag(std::ostream & os, int depth,
string const & latexname) const;
- ///
+ /// Closes SGML/XML tag.
void sgmlCloseTag(std::ostream & os, int depth,
string const & latexname) const;
///
void LinuxDocError(LyXParagraph * par, int pos,
string const & message);
///
- void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
- int desc_on, int depth);
-
- /// LinuxDoc.
- void push_tag(std::ostream & os, string const & tag,
- int & pos, char stack[5][3]);
-
- /// LinuxDoc.
- void pop_tag(std::ostream & os, string const & tag,
- int & pos, char stack[5][3]);
+ void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par, int depth);
/// is save needed
mutable bool lyx_clean;
string filename;
/// Format number of buffer
-#if 0
- float format;
-#else
int file_format;
-#endif
/** A list of views using this buffer.
Why not keep a list of the BufferViews that use this buffer?
if (par) {
++it;
if (it == par->inset_iterator_end()) {
- par = par->next;
+ par = par->next();
SetParagraph();
}
}
if (par) {
++it;
if (it == par->inset_iterator_end()) {
- par = par->next;
+ par = par->next();
SetParagraph();
}
}
friend
bool operator==(inset_iterator const & iter1,
inset_iterator const & iter2);
- //
- //friend
- //bool operator!=(inset_iterator const & iter1,
- // inset_iterator const & iter2);
private:
///
void SetParagraph();
};
+inline
+void Buffer::addUser(BufferView * u)
+{
+ users = u;
+}
+
+
+inline
+void Buffer::delUser(BufferView *)
+{
+ users = 0;
+}
+
+
+inline
+void Buffer::redraw()
+{
+ users->redraw();
+ users->fitCursor(users->text);
+}
+
+
+inline
+Language const * Buffer::GetLanguage() const
+{
+ return params.language;
+}
+
+
+inline
+bool Buffer::isLyxClean() const
+{
+ return lyx_clean;
+}
+
+
+inline
+bool Buffer::isBakClean() const
+{
+ return bak_clean;
+}
+
+
+inline
+void Buffer::markLyxClean() const
+{
+ if (!lyx_clean) {
+ lyx_clean = true;
+ updateTitles();
+ }
+ // if the .lyx file has been saved, we don't need an
+ // autosave
+ bak_clean = true;
+}
+
+
+inline
+void Buffer::markBakClean()
+{
+ bak_clean = true;
+}
+
+
+inline
+void Buffer::setUnnamed(bool flag)
+{
+ unnamed = flag;
+}
+
+
+inline
+bool Buffer::isUnnamed()
+{
+ return unnamed;
+}
+
+
+inline
+void Buffer::markDirty()
+{
+ if (lyx_clean) {
+ lyx_clean = false;
+ updateTitles();
+ }
+ bak_clean = false;
+ DEPCLEAN * tmp = dep_clean;
+ while (tmp) {
+ tmp->clean = false;
+ tmp = tmp->next;
+ }
+}
+
+
+inline
+string const & Buffer::fileName() const
+{
+ return filename;
+}
+
+
+inline
+bool Buffer::isReadonly() const
+{
+ return read_only;
+}
+
+
+inline
+BufferView * Buffer::getUser() const
+{
+ return users;
+}
+
+
inline
void Buffer::setParentName(string const & name)
{
params.parentname = name;
}
+
///
inline
bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
// No need to compare depth.
}
+
///
inline
bool operator==(Buffer::inset_iterator const & iter1,
&& (iter1.par == 0 || iter1.it == iter2.it);
}
+
///
inline
bool operator!=(Buffer::inset_iterator const & iter1,
return !(iter1 == iter2);
}
#endif
-
projects / lyx.git / blobdiff