html_aiguille.hpp

Go to the documentation of this file.

/*********************************************************************/
// webdar - a web server and interface program to libdar
// Copyright (C) 2013-2025 Denis Corbin
//
// This file is part of Webdar
//
//  Webdar is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  Webdar 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with Webdar.  If not, see <http://www.gnu.org/licenses/>
//
//----
//  to contact the author: dar.linux@free.fr
/*********************************************************************/
 
#ifndef HTML_AIGUILLE_HPP
#define HTML_AIGUILLE_HPP
 
 
    // C system header files
#include "my_config.h"
extern "C"
{
 
}
 
    // C++ system header files
#include <string>
#include <list>
#include <map>
 
    // webdar headers
#include "body_builder.hpp"
#include "actor.hpp"
#include "html_void.hpp"
 
 
 
class html_aiguille : public body_builder,
              public html_void_parent_notifier
{
public:
    static constexpr const signed int noactive = -1;
 
    html_aiguille() { clear(); };
    html_aiguille(const html_aiguille & ref) = delete;
    html_aiguille(html_aiguille && ref) noexcept = delete;
    html_aiguille & operator = (const html_aiguille & ref) = delete;
    html_aiguille & operator = (html_aiguille && ref) noexcept = delete;
    ~html_aiguille() = default;
 
    void clear();
 
 
    void add_section(const std::string & name, const std::string & title);
 
 
    void adopt_in_section(const std::string & section_name, body_builder* obj);
 
    void adopt_in_section(signed int num, body_builder* obj);
 
    void clear_section(const std::string & section_name);
 
    void clear_section(signed int num);
 
    void remove_section(const std::string & section_name);
 
    void remove_section(signed int num);
 
    void set_active_section(const std::string & name);
 
    void set_active_section(signed int num);
 
    signed int get_active_section() const { return active_section; };
 
    unsigned int size() const { return order.size(); };
 
    unsigned int section_name_to_num(const std::string & name) const;
 
    std::string num_to_section_name(unsigned int num) const { return order[num]; };
 
    virtual void void_child_will_foresake(body_builder* voidobj, body_builder* obj) override;
 
protected:
 
    // inherited from body_builder
    virtual std::string inherited_get_body_part(const chemin & path,
                        const request & req) override;
 
    // hiding adopt() as it is replaced by adopt_in_section()
    using body_builder::adopt;
 
    // for inherited class to act upon new section addition
    virtual void section_added(const std::string & name, const std::string & title) {};
 
    // for inherited class to act upon section removal
    virtual void section_removed(const std::string & name) {};
 
 
private:
 
    struct section
    {
    std::string title;
    html_void global_visibility; // parent of all objects from the adopted list, and child of "this"
    std::list<body_builder*> adopted;
    };
 
    std::deque<std::string> order;              
    std::map<std::string, section> sections;    
    std::map<body_builder*, std::string> obj_to_section; 
    signed int active_section; 
    bool selfcleaning; 
 
    void set_visibility(signed int section_num, bool visible);
};
 
#endif