]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.h
fix typo that put too many include paths for most people
[lyx.git] / src / buffer.h
index 5f3e8d9d5b0f67881def40f7cb8cc4c128b6a2d3..880cff61b3d91dbbeb4706985e469e5747b8782e 100644 (file)
@@ -1,15 +1,15 @@
 // -*- C++ -*-
 /* This file is part of
- * ====================================================== 
- * 
- *           LyX, The Document Processor        
+ * ======================================================
+ *
+ *           LyX, The Document Processor
  *           Copyright 1995 Matthias Ettrich
  *
  *           This file is Copyleft 1996
  *           Lars Gullik Bjønnes
  *
  * ====================================================== */
+
 #ifndef BUFFER_H
 #define BUFFER_H
 
@@ -66,7 +66,7 @@ public:
            \param b  optional \c false by default
        */
        explicit Buffer(string const & file, bool b = false);
-       
+
        /// Destructor
        ~Buffer();
 
@@ -78,7 +78,7 @@ public:
        /// Maybe we know the function already by number...
        bool dispatch(int ac, string const & argument);
 
-       /// 
+       ///
        void resizeInsets(BufferView *);
 
        /// Update window titles of all users.
@@ -97,19 +97,19 @@ public:
            Since we only can have one at the moment, we just reset it.
        */
        void delUser(BufferView *);
-       
+
        ///
        void redraw();
 
        /// Load the autosaved file.
        void loadAutoSaveFile();
-       
-       /** Reads a file. 
+
+       /** Reads a file.
            \param par if != 0 insert the file.
            \return \c false if method fails.
        */
        bool readFile(LyXLex &, Paragraph * par = 0);
-       
+
        /** Reads a file without header.
            \param par if != 0 insert the file.
            \return \c false if file is not completely read.
@@ -120,15 +120,14 @@ public:
        bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
                                        Paragraph *& return_par,
                                        string const & token, int & pos,
-                                       Paragraph::depth_type & depth, 
+                                       Paragraph::depth_type & depth,
                                        LyXFont &);
        ///
-       void insertStringAsLines(Paragraph *&, Paragraph::pos_type &,
+       void insertStringAsLines(Paragraph *&, lyx::pos_type &,
                                 LyXFont const &, string const &) const;
 #ifndef NO_COMPABILITY
        ///
        void insertErtContents(Paragraph * par, int & pos,
-                              LyXFont const & font,
                               bool set_inactive = true);
 #endif
        ///
@@ -142,17 +141,17 @@ public:
            Returns \c true if the save is successful, \c false otherwise.
        */
        bool save() const;
-       
+
        /// Write file. Returns \c false if unsuccesful.
        bool writeFile(string const &, bool) const;
-       
+
        ///
        void writeFileAscii(string const & , int);
        ///
        void writeFileAscii(std::ostream &, int);
        ///
-       string const asciiParagraph(Paragraph const *,
-                                   unsigned int linelen) const;
+       string const asciiParagraph(Paragraph const *, unsigned int linelen,
+                                   bool noparbreak = false) const;
        ///
        void makeLaTeXFile(string const & filename,
                           string const & original_path,
@@ -167,7 +166,7 @@ public:
                                 Paragraph * par, int & desc_on,
                                 Paragraph::depth_type depth) const ;
        ///
-       void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par, 
+       void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
                                  Paragraph::depth_type depth);
        ///
        void makeLinuxDocFile(string const & filename,
@@ -194,16 +193,16 @@ public:
        bool isBakClean() const;
        ///
        bool isDepClean(string const & name) const;
-       
+
        ///
        void markLyxClean() const;
 
        ///
        void markBakClean();
-       
+
        ///
        void markDepClean(string const & name);
-       
+
        ///
        void setUnnamed(bool flag = true);
 
@@ -213,9 +212,13 @@ public:
        /// Mark this buffer as dirty.
        void markDirty();
 
-       /// Returns the buffers filename.
+       /// Returns the buffer's filename. It is always an absolute path.
        string const & fileName() const;
 
+       /// Returns the the path where the buffer lives.
+       /// It is always an absolute path.
+       string const & filePath() const;
+
        /** A transformed version of the file name, adequate for LaTeX.
            \param no_path optional if \c true then the path is stripped.
        */
@@ -223,7 +226,7 @@ public:
 
        /// 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);
 
@@ -245,8 +248,8 @@ public:
        /** returns \c true if the buffer contains either a LinuxDoc
            or DocBook document */
        bool isSGML() const;
-        /// returns \c true if the buffer contains a Wed document
-        bool isLiterate() const;
+       /// returns \c true if the buffer contains a Wed document
+       bool isLiterate() const;
 
        /** Validate a buffer for LaTeX.
            This validates the buffer, and returns a struct for use by
@@ -294,13 +297,13 @@ public:
 
        /// Does this mean that this is buffer local?
        UndoStack undostack;
-       
-       /// Does this mean that this is buffer local? 
+
+       /// Does this mean that this is buffer local?
        UndoStack redostack;
-       
+
        ///
        BufferParams params;
-       
+
        /** The list of paragraphs.
            This is a linked list of paragraph, this list holds the
            whole contents of the document.
@@ -313,9 +316,6 @@ public:
        /// Where to put temporary files.
        string tmppath;
 
-       /// The path to the document file.
-       string filepath;
-
        /** If we are writing a nice LaTeX file or not.
            While writing as LaTeX, tells whether we are
            doing a 'nice' LaTeX file */
@@ -326,10 +326,10 @@ public:
 private:
        /// is save needed
        mutable bool lyx_clean;
-       
+
        /// is autosave needed
        mutable bool bak_clean;
-       
+
        /// is this a unnamed file (New...)
        bool unnamed;
 
@@ -340,7 +340,10 @@ private:
        bool read_only;
 
        /// name of the file the buffer is associated with.
-       string filename;
+       string filename_;
+
+       /// The path to the document file.
+       string filepath_;
 
        /// Format number of buffer
        int file_format;
@@ -362,8 +365,8 @@ public:
                typedef ptrdiff_t difference_type;
                typedef Inset * pointer;
                typedef Inset & reference;
-               
-               
+
+
                ///
                inset_iterator() : par(0) /*, it(0)*/ {}
                //
@@ -371,8 +374,7 @@ public:
                        setParagraph();
                }
                ///
-               inset_iterator(Paragraph * paragraph,
-                              Paragraph::pos_type pos);
+               inset_iterator(Paragraph * paragraph, lyx::pos_type pos);
                ///
                inset_iterator & operator++() { // prefix ++
                        if (par) {
@@ -398,11 +400,11 @@ public:
                }
                ///
                Inset * operator*() { return *it; }
-               
+
                ///
                Paragraph * getPar() { return par; }
                ///
-               Paragraph::pos_type getPos() const { return it.getPos(); }
+               lyx::pos_type getPos() const { return it.getPos(); }
                ///
                friend
                bool operator==(inset_iterator const & iter1,
@@ -455,21 +457,21 @@ void Buffer::delUser(BufferView *)
 {
        users = 0;
 }
-       
+
 
 inline
 Language const * Buffer::getLanguage() const
 {
        return params.language;
 }
-       
+
 
 inline
 bool Buffer::isLyxClean() const
 {
        return lyx_clean;
 }
-       
+
 
 inline
 bool Buffer::isBakClean() const
@@ -480,13 +482,13 @@ bool Buffer::isBakClean() const
 
 inline
 void Buffer::markLyxClean() const
-{ 
+{
        if (!lyx_clean) {
-               lyx_clean = true; 
+               lyx_clean = true;
                updateTitles();
        }
        // if the .lyx file has been saved, we don't need an
-       // autosave 
+       // autosave
        bak_clean = true;
 }
 
@@ -531,7 +533,14 @@ void Buffer::markDirty()
 inline
 string const & Buffer::fileName() const
 {
-       return filename;
+       return filename_;
+}
+
+
+inline
+string const & Buffer::filePath() const
+{
+       return filepath_;
 }
 
 
@@ -549,10 +558,10 @@ BufferView * Buffer::getUser() const
 }
 
 
-inline  
+inline
 void Buffer::setParentName(string const & name)
 {
-       params.parentname = name;    
+       params.parentname = name;
 }