kworship/css/KwCssScope.cpp

   1 /**
   2  * @file KwCssScope.cpp
   3  * @brief Cascading style scope.
   4  * @author James Hogan <james@albanarts.com>
   5  */
   6
   7 #include "KwCssScope.h"
   8 #include "KwCssStyleRule.h"
   9 #include "KwCssStyleSheet.h"
  10
  11 /*
  12  * Constructors + destructors
  13  */
  14
  15 /// Primary constructor.
  16 KwCssScope::KwCssScope(KwCssScope* parent)
  17 : m_parentScope(parent)
  18 , m_childScopes()
  19 , m_name()
  20 , m_classes()
  21 , m_styleSheets()
  22 , m_styles()
  23 {
  24   if (0 != m_parentScope)
  25   {
  26     parent->m_childScopes.insert(this);
  27   }
  28 }
  29
  30 /// Destructor.
  31 KwCssScope::~KwCssScope()
  32 {
  33   // Remove from parent's child list.
  34   if (0 != m_parentScope)
  35   {
  36     m_parentScope->m_childScopes.remove(this);
  37   }
  38
  39   // Remove from children and recalculate styles.
  40   {
  41     ScopeSet::iterator it;
  42     for (it = m_childScopes.begin(); it != m_childScopes.end(); ++it)
  43     {
  44       (*it)->m_parentScope = 0;
  45       (*it)->recalculateStyles();
  46     }
  47   }
  48
  49   // Clean style sheets
  50   {
  51     StyleSheetList::iterator it;
  52     for (it = m_styleSheets.begin(); it != m_styleSheets.end(); ++it)
  53     {
  54       /// @todo reference count
  55       delete *it;
  56     }
  57   }
  58 }
  59
  60 /*
  61  * Main interface
  62  */
  63
  64 /// Add a stylesheet for this scope.
  65 void KwCssScope::addStyleSheet(KwCssStyleSheet* styleSheet)
  66 {
  67   m_styleSheets.push_back(styleSheet);
  68   recalculateStyles();
  69 }
  70
  71 /// Add a class to this scope.
  72 void KwCssScope::addClass(QString className)
  73 {
  74   m_classes += className;
  75   recalculateStyles();
  76 }
  77
  78 /// Get all the styles included in this scope.
  79 const KwCssStyleStates& KwCssScope::getStyles() const
  80 {
  81   return m_cachedStyles;
  82 }
  83
  84 /// Recalculate all styles.
  85 void KwCssScope::recalculateStyles()
  86 {
  87   /*
  88    * cached styles
  89    * unmatched rules stylesheet
  90    *
  91    * get parent styles
  92    * add classes
  93    * get parent unmatched style rules
  94    * go through stylesheets
  95    *  apply any rules that match in order, removing as we go from local list
  96    * apply explicit styles
  97    */
  98   // Get the base styles from the parent
  99   if (0 != m_parentScope)
 100   {
 101     m_cachedStyles = m_parentScope->getStyles();
 102     m_cachedStyleSheet = m_parentScope->m_cachedStyleSheet;
 103     m_cachedClasses = m_parentScope->m_cachedClasses;
 104   }
 105   else
 106   {
 107     m_cachedStyles.clear();
 108     m_cachedStyleSheet.clear();
 109   }
 110   // Add local stylesheets
 111   {
 112     StyleSheetList::iterator it;
 113     for (it = m_styleSheets.begin(); it != m_styleSheets.end(); ++it)
 114     {
 115       m_cachedStyleSheet.importStyleSheet(*it);
 116     }
 117   }
 118   // Add local classes
 119   m_cachedClasses += m_classes;
 120
 121   // process rules
 122   bool processRules;
 123   do
 124   {
 125     processRules = false;
 126     QSet<QString> triggerableClasses;
 127     KwCssStyleSheet::Iterator it;
 128     for (it = m_cachedStyleSheet.getRules().begin(); it != m_cachedStyleSheet.getRules().end();)
 129     {
 130       // Match the keys
 131       KwCssStyleRule::KeyList& keys = (*it).getCriteriaKeys();
 132       if (!keys.empty() && isKeyMatching(keys.first()))
 133       {
 134         keys.pop_front();
 135       }
 136       // Match the classes
 137       KwCssStyleRule::StringSet& classes = (*it).getCriteriaClasses();
 138       classes -= m_cachedClasses;
 139
 140       if (!classes.empty())
 141       {
 142         triggerableClasses += classes;
 143         ++it;
 144       }
 145       else if (keys.empty())
 146       {
 147         // Nothing left to match, we can apply this style and remove it from the list
 148         m_cachedStyles << *(*it).getStyles();
 149         QSet<QString> classesToApply = (*it).getIncludedStyles() - m_cachedClasses;
 150         if (!classesToApply.empty())
 151         {
 152           m_cachedClasses += classesToApply;
 153           QSet<QString> classesToTrigger = triggerableClasses & classesToApply;
 154           if (!classesToTrigger.empty())
 155           {
 156             triggerableClasses -= classesToTrigger;
 157             processRules = true;
 158           }
 159         }
 160         // Remove from stylesheet since it's now applied
 161         KwCssStyleSheet::Iterator cur = it;
 162         ++it;
 163         m_cachedStyleSheet.getRules().erase(cur);
 164       }
 165       else
 166       {
 167         ++it;
 168       }
 169     }
 170   }
 171   while (processRules);
 172
 173   // Apply each style
 174   m_cachedStyles << m_styles;
 175
 176   // Recurse to children
 177   {
 178     ScopeSet::iterator it;
 179     for (it = m_childScopes.begin(); it != m_childScopes.end(); ++it)
 180     {
 181       (*it)->recalculateStyles();
 182     }
 183   }
 184 }
 185
 186 /*
 187  * Virtual interface
 188  */
 189
 190 /// Get the type id corresponding to this type.
 191 KwCssScopeKey::ScopeTypeId KwCssScope::getTypeId() const
 192 {
 193   /// @todo optimise by caching type id
 194   return KwCssScopeKey::registerScopeType("scope");
 195 }
 196
 197 /*
 198  * Accessors
 199  */
 200
 201 /// Get explicit styles.
 202 const KwCssStyles& KwCssScope::getExplicitStyles() const
 203 {
 204   return m_styles;
 205 }
 206
 207 /// Get the scope's key.
 208 KwCssScopeKey KwCssScope::getKey() const
 209 {
 210   return KwCssScopeKey(getTypeId(), m_name);
 211 }
 212
 213 /// Find whether a scope key matches this scope.
 214 bool KwCssScope::isKeyMatching(KwCssScopeKey key) const
 215 {
 216   return (!key.isTypeSpecified() || key.getTypeId() == getTypeId())
 217       && (!key.isNameSpecified() || key.getName()   == m_name);
 218 }
 219
 220 /*
 221  * Mutators
 222  */
 223
 224 /// Set the parent scope.
 225 void KwCssScope::setParentScope(KwCssScope* parent)
 226 {
 227   if (0 != m_parentScope)
 228   {
 229     m_parentScope->m_childScopes.remove(this);
 230   }
 231   m_parentScope = parent;
 232   if (0 != parent)
 233   {
 234     m_parentScope->m_childScopes.insert(this);
 235   }
 236   recalculateStyles();
 237 }
 238