Fix bug #12772

[lyx.git] / src / BranchList.h

diff --git a/src/BranchList.h b/src/BranchList.h
index 610e97fd48009296c2cb3789ca4cad883286ab79..7bf435217de502f102a968bd4c1ce8a2ea1c296c 100644 (file)
--- a/src/BranchList.h
+++ b/src/BranchList.h
@@ -3,11 +3,26 @@
  * \file BranchList.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
+ *
  * \author Martin Vermeer
  *
  * Full author contact details are available in file CREDITS.
- *
- *
+ */
+
+#ifndef BRANCHLIST_H
+#define BRANCHLIST_H
+
+#include "ColorCode.h"
+
+#include "support/docstring.h"
+
+#include <cstdlib> // rand()
+#include <list>
+
+
+namespace lyx {
+
+/**
  * \class Branch
  *
  * A class describing a 'branch', i.e., a named alternative for
@@ -15,50 +30,72 @@
  * other parts.
  *
  * A branch has a name, can either be selected or not, and uses a
- * user-specifyable background colour. All these can be set and
+ * user-specifiable background colour. All these can be set and
  * queried.
  *
  * \class BranchList
  *
  * A class containing a vector of all defined branches within a
- * document. Has methods for selecting or deselecting branches by
+ * document. It has methods for selecting or deselecting branches by
  * name, for outputting a '|'-separated string of all elements or only
  * the selected ones, and for adding and removing elements.
  */
 
-
-#ifndef BRANCHES_H
-#define BRANCHES_H
-
-#include <string>
-#include <list>
-
-
 class Branch {
 public:
        ///
-       std::string const & getBranch() const;
+       Branch() {}
        ///
-       void setBranch(std::string const &);
+       docstring const & branch() const;
        ///
-       bool getSelected() const;
+       void setBranch(docstring const &);
+       ///
+       bool isSelected() const;
        /** Select/deselect the branch.
         *  \return true if the selection status changes.
         */
        bool setSelected(bool);
+       /** If true, the branch name will be appended
+        *  to the output file name.
+        */
+       bool hasFileNameSuffix() const;
+       /// Select/deselect filename suffix property.
+       void setFileNameSuffix(bool);
        ///
-       std::string const & getColor() const;
+       void setListID(int const id) { branch_list_id_ = id; }
        ///
-       void setColor(std::string const &);
-
+       std::string const & color() const;
+       ///
+       std::string const & lightModeColor() const;
+       ///
+       std::string const & darkModeColor() const;
+       /**
+        * Set background color from a hexcolor string "#rrggbb" or a lyx color name.
+        * Use Color:background if the string is no valid color.
+        * This ensures compatibility with LyX 1.4.0 that had the symbolic
+        * color "none" that was displayed as Color:background.
+        * This sets the dark color if in dark mode, else the light color.
+        */
+       void setColor(std::string const & color);
+       /// Set dark and light background colors
+       void setColors(std::string const & color,
+                     std::string const & dmcolor = std::string());
+       ///
+       int listID() const { return branch_list_id_; }
 
 private:
        ///
-       std::string branch_;
+       docstring branch_;
        ///
-       bool selected_;
+       bool selected_ = false;
        ///
-       std::string color_;
+       bool filenameSuffix_ = false;
+       /// light mode background color
+       std::string lmcolor_ = "background";
+       /// dark mode background color
+       std::string dmcolor_ = "background";
+       ///
+       int branch_list_id_ = 0;
 };
 
 
@@ -69,48 +106,53 @@ public:
        typedef List::const_iterator const_iterator;
 
        ///
-       BranchList() : separator_("|") {}
+       BranchList() : separator_(from_ascii("|")), id_(rand()) {}
+
+       ///
+       docstring separator() const { return separator_; }
+
+       ///
+       int id() const { return id_; }
 
        ///
-       bool empty() const { return list.empty(); }
+       bool empty() const { return list_.empty(); }
        ///
-       void clear() { list.clear(); }
+       void clear() { list_.clear(); }
        ///
-       const_iterator begin() const { return list.begin(); }
-       const_iterator end() const { return list.end(); }
+       const_iterator begin() const { return list_.begin(); }
+       const_iterator end() const { return list_.end(); }
 
        /** \returns the Branch with \c name. If not found, returns 0.
         */
-       Branch * find(std::string const & name);
-       Branch const * find(std::string const & name) const;
+       Branch * find(docstring const & name);
+       Branch const * find(docstring const & name) const;
 
        /** Add (possibly multiple (separated by separator())) branches to list
         *  \returns true if a branch is added.
         */
-       bool add(std::string const &);
+       bool add(docstring const &);
        /** remove a branch from list by name
         *  \returns true if a branch is removed.
         */
-       bool remove(std::string const &);
+       bool remove(docstring const &);
+       /** rename an branch in list
+        *  \returns true if renaming succeeded.
+        * if \p merge is true, the branch will be removed
+        * if a branch with the newname already exists.
+        */
+       bool rename(docstring const &, docstring const &, bool const merge = false);
+       /// get the complete filename suffix
+       docstring getFileNameSuffix() const;
 
 private:
        ///
-       List list;
+       List list_;
+       ///
+       docstring separator_;
        ///
-       std::string separator_;
+       int id_;
 };
 
+} // namespace lyx
 
-class BranchNamesEqual : public std::unary_function<Branch, bool> {
-public:
-       BranchNamesEqual(std::string const & name)
-               : name_(name) {}
-       bool operator()(Branch const & branch) const
-       {
-               return branch.getBranch() == name_;
-       }
-private:
-       std::string name_;
-};
-
-#endif
+#endif // BRANCHLIST_H