src/BranchList.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BranchList.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Martin Vermeer
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef BRANCHLIST_H
  13 #define BRANCHLIST_H
  14
  15 #include "ColorCode.h"
  16
  17 #include "support/docstring.h"
  18
  19 #include <list>
  20
  21
  22 namespace lyx {
  23
  24 /**
  25  * \class Branch
  26  *
  27  * A class describing a 'branch', i.e., a named alternative for
  28  * selectively outputting some parts of a document while suppressing
  29  * other parts.
  30  *
  31  * A branch has a name, can either be selected or not, and uses a
  32  * user-specifiable background colour. All these can be set and
  33  * queried.
  34  *
  35  * \class BranchList
  36  *
  37  * A class containing a vector of all defined branches within a
  38  * document. It has methods for selecting or deselecting branches by
  39  * name, for outputting a '|'-separated string of all elements or only
  40  * the selected ones, and for adding and removing elements.
  41  */
  42
  43 class Branch {
  44 public:
  45         ///
  46         Branch();
  47         ///
  48         docstring const & branch() const;
  49         ///
  50         void setBranch(docstring const &);
  51         ///
  52         bool isSelected() const;
  53         /** Select/deselect the branch.
  54          *  \return true if the selection status changes.
  55          */
  56         bool setSelected(bool);
  57         /** If true, the branch name will be appended
  58          *  to the output file name.
  59          */
  60         bool hasFileNameSuffix() const;
  61         /// Select/deselect filename suffix property.
  62         void setFileNameSuffix(bool);
  63         ///
  64         std::string const & color() const;
  65         /**
  66          * Set color from a string "#rrggbb".
  67          * Use Color:background if the string is no valid color.
  68          * This ensures compatibility with LyX 1.4.0 that had the symbolic
  69          * color "none" that was displayed as Color:background.
  70          */
  71         void setColor(std::string const &);
  72
  73 private:
  74         ///
  75         docstring branch_;
  76         ///
  77         bool selected_;
  78         ///
  79         bool filenameSuffix_;
  80         ///
  81         std::string color_;
  82 };
  83
  84
  85 class BranchList {
  86         ///
  87         typedef std::list<Branch> List;
  88 public:
  89         typedef List::const_iterator const_iterator;
  90
  91         ///
  92         BranchList() : separator_(from_ascii("|")) {}
  93
  94         ///
  95         docstring separator() const { return separator_; }
  96
  97         ///
  98         bool empty() const { return list_.empty(); }
  99         ///
 100         void clear() { list_.clear(); }
 101         ///
 102         const_iterator begin() const { return list_.begin(); }
 103         const_iterator end() const { return list_.end(); }
 104
 105         /** \returns the Branch with \c name. If not found, returns 0.
 106          */
 107         Branch * find(docstring const & name);
 108         Branch const * find(docstring const & name) const;
 109
 110         /** Add (possibly multiple (separated by separator())) branches to list
 111          *  \returns true if a branch is added.
 112          */
 113         bool add(docstring const &);
 114         /** remove a branch from list by name
 115          *  \returns true if a branch is removed.
 116          */
 117         bool remove(docstring const &);
 118         /** rename an branch in list
 119          *  \returns true if renaming succeeded.
 120          * if \p merge is true, the branch will be removed
 121          * if a branch with the newname already exists.
 122          */
 123         bool rename(docstring const &, docstring const &, bool const merge = false);
 124         /// get the complete filename suffix
 125         docstring getFileNameSuffix() const;
 126
 127 private:
 128         ///
 129         List list_;
 130         ///
 131         docstring separator_;
 132 };
 133
 134 } // namespace lyx
 135
 136 #endif // BRANCHLIST_H