Device.h

/*
 * Copyright (c) [2014-2015] Novell, Inc.
 * Copyright (c) [2016-2020] SUSE LLC
 *
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as published
 * by the Free Software Foundation.
 *
 * 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 General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, contact Novell, Inc.
 *
 * To contact Novell about this file by physical or electronic mail, you may
 * find current contact information at www.novell.com.
 */
 
 
#ifndef STORAGE_DEVICE_H
#define STORAGE_DEVICE_H
 
 
#include <libxml/tree.h>
#include <string>
#include <vector>
#include <map>
#include <memory>
#include <boost/noncopyable.hpp>
 
#include "storage/Utils/Exception.h"
#include "storage/Utils/Swig.h"
#include "storage/View.h"
 
 
namespace storage
{
    class Devicegraph;
    class Holder;
    class ResizeInfo;
 
 
    class DeviceHasWrongType : public Exception
    {
    public:
 
        DeviceHasWrongType(const char* seen, const char* expected);
    };
 
 
    typedef unsigned int sid_t;
 
 
    class Device : private boost::noncopyable
    {
 
    public:
 
        virtual ~Device();
 
        sid_t get_sid() const;
 
        bool operator==(const Device& rhs) const;
        bool operator!=(const Device& rhs) const;
 
        Device* copy_to_devicegraph(Devicegraph* devicegraph) const;
 
        bool exists_in_devicegraph(const Devicegraph* devicegraph) const;
 
        bool exists_in_probed() const;
 
        bool exists_in_staging() const;
 
        bool exists_in_system() const;
 
        std::string get_displayname() const;
 
        ResizeInfo detect_resize_info() const;
 
        bool has_children() const;
        size_t num_children() const;
 
        bool has_parents() const;
        size_t num_parents() const;
 
        static std::vector<Device*> get_all(Devicegraph* devicegraph);
 
        static std::vector<const Device*> get_all(const Devicegraph* devicegraph);
 
        // TODO check if we can somehow return a iterator. getting rid of the
        // ptr would also allow to use references instead of pointer in the
        // interface.
 
        // all function without a view are obsolete (to be replaced by functions with
        // default view)
 
        std::vector<Device*> get_children();
        std::vector<const Device*> get_children() const;
 
        std::vector<Device*> get_children(View view);
 
        std::vector<const Device*> get_children(View view) const;
 
        std::vector<Device*> get_parents();
        std::vector<const Device*> get_parents() const;
 
        std::vector<Device*> get_parents(View view);
 
        std::vector<const Device*> get_parents(View view) const;
 
        std::vector<Device*> get_siblings(bool itself);
        std::vector<const Device*> get_siblings(bool itself) const;
 
        std::vector<Device*> get_descendants(bool itself);
        std::vector<const Device*> get_descendants(bool itself) const;
 
        std::vector<Device*> get_descendants(bool itself, View view);
        std::vector<const Device*> get_descendants(bool itself, View view) const;
 
        std::vector<Device*> get_ancestors(bool itself);
        std::vector<const Device*> get_ancestors(bool itself) const;
 
        std::vector<Device*> get_leaves(bool itself);
        std::vector<const Device*> get_leaves(bool itself) const;
 
        std::vector<Device*> get_roots(bool itself);
        std::vector<const Device*> get_roots(bool itself) const;
 
        std::vector<Holder*> get_in_holders();
        std::vector<const Holder*> get_in_holders() const;
 
        std::vector<Holder*> get_out_holders();
        std::vector<const Holder*> get_out_holders() const;
 
        void remove_descendants() ST_DEPRECATED;
 
        void remove_descendants(View view);
 
        const std::map<std::string, std::string>& get_userdata() const;
 
        void set_userdata(const std::map<std::string, std::string>& userdata);
 
        friend std::ostream& operator<<(std::ostream& out, const Device& device);
 
        static bool compare_by_sid(const Device* lhs, const Device* rhs);
 
        static bool compare_by_name(const Device* lhs, const Device* rhs);
 
        std::string get_name_sort_key() const;
 
        Devicegraph* get_devicegraph();
        const Devicegraph* get_devicegraph() const;
 
    public:
 
        class Impl;
 
        Impl& get_impl() { return *impl; }
        const Impl& get_impl() const { return *impl; }
 
        virtual Device* clone() const = 0;
 
        void save(xmlNode* node) const ST_DEPRECATED;
 
    protected:
 
        Device(Impl* impl);
 
        void create(Devicegraph* devicegraph);
 
        void load(Devicegraph* devicegraph);
 
    private:
 
        void add_to_devicegraph(Devicegraph* devicegraph);
 
        const std::unique_ptr<Impl> impl;
 
    };
 
}
 
#endif