cyfaust 0.1.0__cp311-cp311-macosx_15_0_arm64.whl

cyfaust/resources/architecture/faust/gui/LayoutUI.h

@@ -0,0 +1,423 @@
+/************************** BEGIN LayoutUI.h **************************
+ FAUST Architecture File
+ Copyright (C) 2003-2022 GRAME, Centre National de Creation Musicale
+ ---------------------------------------------------------------------
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+ 
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+ 
+ You should have received a copy of the GNU Lesser General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ 
+ EXCEPTION : As a special exception, you may create a larger work
+ that contains this FAUST architecture section and distribute
+ that work under terms of your choice, so long as this FAUST
+ architecture section is not modified.
+ ************************************************************************/
+
+#ifndef FAUST_LAYOUTUI_H
+#define FAUST_LAYOUTUI_H
+
+#include <vector>
+#include <string>
+#include <map>
+#include <stack>
+#include <iostream>
+#include <ostream>
+
+#include "faust/gui/DecoratorUI.h"
+#include "faust/gui/PathBuilder.h"
+#include "faust/gui/MetaDataUI.h"
+
+/*******************************************************************************
+ * LayoutUI
+ ******************************************************************************/
+
+// Definition of the elements standard size
+
+struct LayoutItemSize {
+    
+    float kKnobWidth = 10.f;
+    float kKnobHeight = 10.f;
+
+    float kVSliderWidth = 10.f;
+    float kVSliderHeight = 25.f;
+
+    float kHSliderWidth = 25.f;
+    float kHSliderHeight = 10.f;
+
+    float kButtonWidth = 10.f;
+    float kButtonHeight = 10.f;
+
+    float kCheckButtonWidth = 10.f;
+    float kCheckButtonHeight = 10.f;
+
+    float kNumEntryWidth = 10.f;
+    float kNumEntryHeight = 10.f;
+
+    float kVBargraphWidth = 10.f;
+    float kVBargraphHeight = 20.f;
+
+    float kHBargraphWidth = 20.f;
+    float kHBargraphHeight = 10.f;
+};
+
+static LayoutItemSize gItemSize;
+
+struct LayoutUI : public GenericUI, public PathBuilder, public MetaDataUI
+{
+
+    // Base class
+    struct UIItem {
+        
+        typedef std::shared_ptr<UIItem> shared_item;
+      
+        std::string fLabel;
+        
+        UIItem(const std::string& label):fLabel(label) {}
+        virtual ~UIItem() {}
+        
+        virtual float getTopX() { return 0.f; };
+        virtual float getTopY() { return 0.f; };
+        
+        virtual float getBorderX() { return 0.f; };
+        virtual float getBorderY() { return 0.f; };
+        
+        virtual float getWidth() { return 0.f; };
+        virtual float getHeight() { return 0.f; };
+        
+        virtual void setSize(float width, float height) {}
+        virtual void setPos(float top_x, float top_y) {}
+        
+        virtual std::ostream& print(std::ostream& file) { return file; }
+    };
+    
+    // Leave
+    struct UILeaveItem : UIItem  {
+        
+        float fBorderX = 0.f;
+        float fBorderY = 0.f;
+        
+        float fWidth = 0.f;
+        float fHeight = 0.f;
+        
+        float fTopX = 0.f;
+        float fTopY = 0.f;
+        
+        UILeaveItem(const std::string& label,
+                    float width = 0.0f,
+                    float height = 0.0f)
+            :UIItem(label), fWidth(width), fHeight(height) {}
+       
+        float getTopX() override { return fTopX; };
+        float getTopY() override { return fTopY; };
+        
+        float getBorderX() override { return fBorderX; };
+        float getBorderY() override { return fBorderY; };
+        
+        float getWidth() override { return fWidth; }
+        float getHeight() override { return fHeight; }
+        
+        // Adapt all leave sizes
+        void setSize(float width, float height) override
+        {
+            fWidth = width;
+            fHeight = height;
+        }
+        
+        // Adapt all leave positions
+        void setPos(float top_x, float top_y) override
+        {
+            fTopX = top_x;
+            fTopY = top_y;
+        }
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "fTopX = " << fTopX << " fTopY = " << fTopY << std::endl;
+            file <<"fWidth = " << fWidth << " fHeight = " << fHeight << std::endl;
+            file << "--------------------------" << std::endl;
+            return file;
+        }
+    };
+    
+    // Grouping classes
+    struct Group : UIItem {
+        
+        typedef std::shared_ptr<Group> shared_group;
+        
+        std::vector <UIItem::shared_item> fItems;
+        
+        Group(const std::string& label):UIItem(label)
+        {}
+        virtual ~Group()
+        {}
+        
+        void add(UIItem::shared_item item) { fItems.push_back(item); }
+        
+        void setSize(float width, float height) override
+        {
+            float real_width = getWidth() - getBorderX();
+            float real_height = getHeight() - getBorderY();
+            
+            float w_ratio = width / real_width;
+            float h_ratio = height / real_height;
+            
+            for (const auto& it : fItems) {
+                it->setSize(it->getWidth() * w_ratio, it->getHeight() * h_ratio);
+            }
+        }
+        
+    };
+    
+    struct HGroup : Group {
+        
+        HGroup(const std::string& label):Group(label)
+        {}
+        
+        float getWidth() override
+        {
+            float res = 0.f;
+            for (const auto& it : fItems) {
+                res += it->getWidth();
+            }
+            return res;
+        }
+        
+        float getHeight() override
+        {
+            float res = 0.f;
+            for (const auto& it : fItems) {
+                res = std::max(res, it->getHeight());
+            }
+            return res;
+        }
+        
+        void setPos(float top_x, float top_y) override
+        {
+            for (const auto& it : fItems) {
+                it->setPos(top_x, top_y);
+                top_x += it->getWidth();
+            }
+        }
+    };
+    
+    struct VGroup : Group {
+        
+        VGroup(const std::string& label):Group(label)
+        {}
+        
+        float getWidth() override
+        {
+            float res = 0.f;
+            for (const auto& it : fItems) {
+                res = std::max(res, it->getWidth());
+            }
+            return res;
+        }
+        
+        float getHeight() override
+        {
+            float res = 0.f;
+            for (const auto& it : fItems) {
+                res += it->getHeight();
+            }
+            return res;
+        }
+        
+        void setPos(float top_x, float top_y) override
+        {
+            for (const auto& it : fItems) {
+                it->setPos(top_x, top_y);
+                top_y += it->getHeight();
+            }
+        }
+    };
+    
+    // Terminal items
+    struct Button : UILeaveItem {
+        
+        Button(const std::string& label):UILeaveItem(label, gItemSize.kButtonWidth, gItemSize.kButtonHeight) {}
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "----------Button----------" << std::endl;
+            return UILeaveItem::print(file);
+        }
+    };
+    
+    struct CheckButton : UILeaveItem {
+        
+        CheckButton(const std::string& label):UILeaveItem(label, gItemSize.kCheckButtonWidth, gItemSize.kCheckButtonHeight) {}
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "----------CheckButton----------" << std::endl;
+            return UILeaveItem::print(file);
+        }
+    };
+    
+    struct HSlider : UILeaveItem {
+        
+        HSlider(const std::string& label):UILeaveItem(label, gItemSize.kVSliderWidth, gItemSize.kVSliderHeight) {}
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "----------HSlider----------" << std::endl;
+            return UILeaveItem::print(file);
+        }
+    };
+    
+    struct VSlider : UILeaveItem {
+        
+        VSlider(const std::string& label):UILeaveItem(label, gItemSize.kHSliderWidth, gItemSize.kHSliderHeight) {}
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "----------VSlider----------" << std::endl;
+            return UILeaveItem::print(file);
+        }
+    };
+    
+    struct NumEntry : UILeaveItem {
+        
+        NumEntry(const std::string& label):UILeaveItem(label, gItemSize.kNumEntryWidth, gItemSize.kNumEntryHeight) {}
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "----------NumEntry----------" << std::endl;
+            return UILeaveItem::print(file);
+        }
+    };
+    
+    struct HBargraph : UILeaveItem {
+        
+        HBargraph(const std::string& label):UILeaveItem(label, gItemSize.kHBargraphWidth, gItemSize.kHBargraphHeight) {}
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "----------HBargraph----------" << std::endl;
+            return UILeaveItem::print(file);
+        }
+    };
+    
+    struct VBargraph : UILeaveItem {
+        
+        VBargraph(const std::string& label):UILeaveItem(label, gItemSize.kVBargraphWidth, gItemSize.kVBargraphHeight) {}
+        
+        std::ostream& print(std::ostream& file) override
+        {
+            file << "----------VBargraph----------" << std::endl;
+            return UILeaveItem::print(file);
+        }
+    };
+    
+    Group::shared_group fCurrentGroup = nullptr;
+    std::stack<Group::shared_group> fGroupStack;
+    std::map<std::string, UIItem::shared_item> fPathItemMap;
+
+    void addItem(const char* label, UIItem::shared_item item)
+    {
+        fPathItemMap[buildPath(label)] = item;
+        fCurrentGroup->add(item);
+    }
+
+    void addGroup(const char* label, Group::shared_group group)
+    {
+        pushLabel(label);
+        if (fCurrentGroup) {
+            fCurrentGroup->add(group);
+            fGroupStack.push(fCurrentGroup);
+        }
+        fCurrentGroup = group;
+    }
+
+    LayoutUI() {}
+    virtual ~LayoutUI() {}
+
+    // -- widget's layouts
+
+    virtual void openTabBox(const char* label) override
+    {
+        pushLabel(label);
+    }
+
+    virtual void openHorizontalBox(const char* label) override
+    {
+        addGroup(label, std::make_shared<HGroup>(label));
+    }
+
+    virtual void openVerticalBox(const char* label) override
+    {
+        addGroup(label, std::make_shared<VGroup>(label));
+    }
+
+    virtual void closeBox() override
+    {
+        popLabel();
+        if (fGroupStack.empty()) {
+            // Nothing for now
+        } else {
+            fCurrentGroup = fGroupStack.top();
+            fGroupStack.pop();
+        }
+    }
+
+    // -- active widgets
+
+    virtual void addButton(const char* label, FAUSTFLOAT* zone) override
+    {
+        addItem(label, std::make_shared<Button>(label));
+    }
+    virtual void addCheckButton(const char* label, FAUSTFLOAT* zone) override
+    {
+        addItem(label, std::make_shared<CheckButton>(label));
+    }
+    virtual void addVerticalSlider(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT init, FAUSTFLOAT min, FAUSTFLOAT max, FAUSTFLOAT step) override
+    {
+        addItem(label, std::make_shared<VSlider>(label));
+    }
+    virtual void addHorizontalSlider(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT init, FAUSTFLOAT min, FAUSTFLOAT max, FAUSTFLOAT step) override
+    {
+        addItem(label, std::make_shared<HSlider>(label));
+    }
+    virtual void addNumEntry(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT init, FAUSTFLOAT min, FAUSTFLOAT max, FAUSTFLOAT step) override
+    {
+        addItem(label, std::make_shared<NumEntry>(label));
+    }
+
+    // -- passive widgets
+
+    virtual void addHorizontalBargraph(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT min, FAUSTFLOAT max) override
+    {
+        addItem(label, std::make_shared<HBargraph>(label));
+    }
+    virtual void addVerticalBargraph(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT min, FAUSTFLOAT max) override
+    {
+        addItem(label, std::make_shared<VBargraph>(label));
+    }
+
+    // -- metadata declarations
+
+    virtual void declare(FAUSTFLOAT* zone, const char* key, const char* val) override
+    {
+        MetaDataUI::declare(zone, key, val);
+    }
+};
+
+// Generic print
+template <typename T>
+inline std::ostream& operator<<(std::ostream& file, std::shared_ptr<T> item)
+{
+    return item->print(file);
+}
+
+#endif // FAUST_LAYOUTUI_H
+/**************************  END  LayoutUI.h **************************/