juce/source/src/gui/components/positioning/juce_RelativeRectangle.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #include "../../../core/juce_StandardHeader.h"
  27
  28 BEGIN_JUCE_NAMESPACE
  29
  30 #include "juce_RelativeRectangle.h"
  31 #include "juce_RelativeCoordinatePositioner.h"
  32
  33
  34 //==============================================================================
  35 namespace RelativeRectangleHelpers
  36 {
  37     inline void skipComma (String::CharPointerType& s)
  38     {
  39         s = s.findEndOfWhitespace();
  40
  41         if (*s == ',')
  42             ++s;
  43     }
  44
  45     bool dependsOnSymbolsOtherThanThis (const Expression& e)
  46     {
  47         if (e.getType() == Expression::operatorType && e.getSymbolOrFunction() == ".")
  48             return true;
  49
  50         if (e.getType() == Expression::symbolType)
  51         {
  52             switch (RelativeCoordinate::StandardStrings::getTypeOf (e.getSymbolOrFunction()))
  53             {
  54                 case RelativeCoordinate::StandardStrings::x:
  55                 case RelativeCoordinate::StandardStrings::y:
  56                 case RelativeCoordinate::StandardStrings::left:
  57                 case RelativeCoordinate::StandardStrings::right:
  58                 case RelativeCoordinate::StandardStrings::top:
  59                 case RelativeCoordinate::StandardStrings::bottom:   return false;
  60                 default: break;
  61             }
  62
  63             return true;
  64         }
  65         else
  66         {
  67             for (int i = e.getNumInputs(); --i >= 0;)
  68                 if (dependsOnSymbolsOtherThanThis (e.getInput(i)))
  69                     return true;
  70         }
  71
  72         return false;
  73     }
  74 }
  75
  76 //==============================================================================
  77 RelativeRectangle::RelativeRectangle()
  78 {
  79 }
  80
  81 RelativeRectangle::RelativeRectangle (const RelativeCoordinate& left_, const RelativeCoordinate& right_,
  82                                       const RelativeCoordinate& top_, const RelativeCoordinate& bottom_)
  83     : left (left_), right (right_), top (top_), bottom (bottom_)
  84 {
  85 }
  86
  87 RelativeRectangle::RelativeRectangle (const Rectangle<float>& rect)
  88     : left (rect.getX()),
  89       right (Expression::symbol (RelativeCoordinate::Strings::left) + Expression ((double) rect.getWidth())),
  90       top (rect.getY()),
  91       bottom (Expression::symbol (RelativeCoordinate::Strings::top) + Expression ((double) rect.getHeight()))
  92 {
  93 }
  94
  95 RelativeRectangle::RelativeRectangle (const String& s)
  96 {
  97     String::CharPointerType text (s.getCharPointer());
  98     left = RelativeCoordinate (Expression::parse (text));
  99     RelativeRectangleHelpers::skipComma (text);
 100     top = RelativeCoordinate (Expression::parse (text));
 101     RelativeRectangleHelpers::skipComma (text);
 102     right = RelativeCoordinate (Expression::parse (text));
 103     RelativeRectangleHelpers::skipComma (text);
 104     bottom = RelativeCoordinate (Expression::parse (text));
 105 }
 106
 107 bool RelativeRectangle::operator== (const RelativeRectangle& other) const noexcept
 108 {
 109     return left == other.left && top == other.top && right == other.right && bottom == other.bottom;
 110 }
 111
 112 bool RelativeRectangle::operator!= (const RelativeRectangle& other) const noexcept
 113 {
 114     return ! operator== (other);
 115 }
 116
 117 //==============================================================================
 118 // An expression context that can evaluate expressions using "this"
 119 class RelativeRectangleLocalScope  : public Expression::Scope
 120 {
 121 public:
 122     RelativeRectangleLocalScope (const RelativeRectangle& rect_)  : rect (rect_) {}
 123
 124     Expression getSymbolValue (const String& symbol) const
 125     {
 126         switch (RelativeCoordinate::StandardStrings::getTypeOf (symbol))
 127         {
 128             case RelativeCoordinate::StandardStrings::x:
 129             case RelativeCoordinate::StandardStrings::left:     return rect.left.getExpression();
 130             case RelativeCoordinate::StandardStrings::y:
 131             case RelativeCoordinate::StandardStrings::top:      return rect.top.getExpression();
 132             case RelativeCoordinate::StandardStrings::right:    return rect.right.getExpression();
 133             case RelativeCoordinate::StandardStrings::bottom:   return rect.bottom.getExpression();
 134             default: break;
 135         }
 136
 137         return Expression::Scope::getSymbolValue (symbol);
 138     }
 139
 140 private:
 141     const RelativeRectangle& rect;
 142
 143     JUCE_DECLARE_NON_COPYABLE (RelativeRectangleLocalScope);
 144 };
 145
 146 const Rectangle<float> RelativeRectangle::resolve (const Expression::Scope* scope) const
 147 {
 148     if (scope == nullptr)
 149     {
 150         RelativeRectangleLocalScope defaultScope (*this);
 151         return resolve (&defaultScope);
 152     }
 153     else
 154     {
 155         const double l = left.resolve (scope);
 156         const double r = right.resolve (scope);
 157         const double t = top.resolve (scope);
 158         const double b = bottom.resolve (scope);
 159
 160         return Rectangle<float> ((float) l, (float) t, (float) jmax (0.0, r - l), (float) jmax (0.0, b - t));
 161     }
 162 }
 163
 164 void RelativeRectangle::moveToAbsolute (const Rectangle<float>& newPos, const Expression::Scope* scope)
 165 {
 166     left.moveToAbsolute (newPos.getX(), scope);
 167     right.moveToAbsolute (newPos.getRight(), scope);
 168     top.moveToAbsolute (newPos.getY(), scope);
 169     bottom.moveToAbsolute (newPos.getBottom(), scope);
 170 }
 171
 172 bool RelativeRectangle::isDynamic() const
 173 {
 174     using namespace RelativeRectangleHelpers;
 175
 176     return dependsOnSymbolsOtherThanThis (left.getExpression())
 177             || dependsOnSymbolsOtherThanThis (right.getExpression())
 178             || dependsOnSymbolsOtherThanThis (top.getExpression())
 179             || dependsOnSymbolsOtherThanThis (bottom.getExpression());
 180 }
 181
 182 String RelativeRectangle::toString() const
 183 {
 184     return left.toString() + ", " + top.toString() + ", " + right.toString() + ", " + bottom.toString();
 185 }
 186
 187 void RelativeRectangle::renameSymbol (const Expression::Symbol& oldSymbol, const String& newName, const Expression::Scope& scope)
 188 {
 189     left = left.getExpression().withRenamedSymbol (oldSymbol, newName, scope);
 190     right = right.getExpression().withRenamedSymbol (oldSymbol, newName, scope);
 191     top = top.getExpression().withRenamedSymbol (oldSymbol, newName, scope);
 192     bottom = bottom.getExpression().withRenamedSymbol (oldSymbol, newName, scope);
 193 }
 194
 195 //==============================================================================
 196 class RelativeRectangleComponentPositioner  : public RelativeCoordinatePositionerBase
 197 {
 198 public:
 199     RelativeRectangleComponentPositioner (Component& component_, const RelativeRectangle& rectangle_)
 200         : RelativeCoordinatePositionerBase (component_),
 201           rectangle (rectangle_)
 202     {
 203     }
 204
 205     bool registerCoordinates()
 206     {
 207         bool ok = addCoordinate (rectangle.left);
 208         ok = addCoordinate (rectangle.right) && ok;
 209         ok = addCoordinate (rectangle.top) && ok;
 210         ok = addCoordinate (rectangle.bottom) && ok;
 211         return ok;
 212     }
 213
 214     bool isUsingRectangle (const RelativeRectangle& other) const noexcept
 215     {
 216         return rectangle == other;
 217     }
 218
 219     void applyToComponentBounds()
 220     {
 221         for (int i = 4; --i >= 0;)
 222         {
 223             ComponentScope scope (getComponent());
 224             const Rectangle<int> newBounds (rectangle.resolve (&scope).getSmallestIntegerContainer());
 225
 226             if (newBounds == getComponent().getBounds())
 227                 return;
 228
 229             getComponent().setBounds (newBounds);
 230         }
 231
 232         jassertfalse; // must be a recursive reference!
 233     }
 234
 235     void applyNewBounds (const Rectangle<int>& newBounds)
 236     {
 237         if (newBounds != getComponent().getBounds())
 238         {
 239             ComponentScope scope (getComponent());
 240             rectangle.moveToAbsolute (newBounds.toFloat(), &scope);
 241
 242             applyToComponentBounds();
 243         }
 244     }
 245
 246 private:
 247     RelativeRectangle rectangle;
 248
 249     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (RelativeRectangleComponentPositioner);
 250 };
 251
 252 void RelativeRectangle::applyToComponent (Component& component) const
 253 {
 254     if (isDynamic())
 255     {
 256         RelativeRectangleComponentPositioner* current = dynamic_cast <RelativeRectangleComponentPositioner*> (component.getPositioner());
 257
 258         if (current == nullptr || ! current->isUsingRectangle (*this))
 259         {
 260             RelativeRectangleComponentPositioner* p = new RelativeRectangleComponentPositioner (component, *this);
 261
 262             component.setPositioner (p);
 263             p->apply();
 264         }
 265     }
 266     else
 267     {
 268         component.setPositioner (nullptr);
 269         component.setBounds (resolve (nullptr).getSmallestIntegerContainer());
 270     }
 271 }
 272
 273
 274 END_JUCE_NAMESPACE