Bundle.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#pragma once
 
#include <cstdlib>
#include <memory>
 
#include "celix_bundle.h"
 
namespace celix {
 
    enum class BundleState : std::uint8_t {
        UNKNOWN,
        UNINSTALLED,
        INSTALLED,
        RESOLVED,
        STARTING,
        STOPPING,
        ACTIVE,
    };
 
    class Bundle {
    public:
        explicit Bundle(celix_bundle_t* _cBnd) : cBnd{_cBnd, [](celix_bundle_t*){/*nop*/}} {}
 
        long getId() const { return celix_bundle_getId(cBnd.get()); }
 
#if __cplusplus >= 201703L //C++17 or higher
        std::string getEntry(std::string_view path) const {
            return getEntryInternal(path.data());
        }
#else
        std::string getEntry(const std::string& path) const {
            return getEntryInternal(path.c_str());
        }
#endif
 
#if __cplusplus >= 201703L //C++17 or higher
        std::string getDataFile(std::string_view path) const {
            return getDataFileInternal(path.data());
        }
#else
        std::string getDataFile(const std::string& path) const {
            return getDataFileInternal(path.c_str());
        }
#endif
 
#if __cplusplus >= 201703L //C++17 or higher
        std::string getManifestValue(std::string_view attribute) const {
            const char* header = celix_bundle_getManifestValue(cBnd.get(), attribute.data());
            return header == nullptr ? std::string{} : std::string{header};
        }
#else
        std::string getManifestValue(const std::string& attribute) const {
            const char* header = celix_bundle_getManifestValue(cBnd.get(), attribute.c_str());
            return header == nullptr ? std::string{} : std::string{header};
        }
#endif
 
        std::string getSymbolicName() const {
            return std::string{celix_bundle_getSymbolicName(cBnd.get())};
        }
 
        std::string getName() const {
            return std::string{celix_bundle_getName(cBnd.get())};
        }
 
        std::string getGroup() const {
            return std::string{celix_bundle_getGroup(cBnd.get())};
        }
 
        std::string getDescription() const {
            return std::string{celix_bundle_getDescription(cBnd.get())};
        }
 
        std::string getLocation() const {
            auto* loc = celix_bundle_getLocation(cBnd.get());
            return convertCStringToStdString(loc);
        }
 
        celix::BundleState getState() const {
            auto cState = celix_bundle_getState(cBnd.get());
            switch (cState) {
                case CELIX_BUNDLE_STATE_UNINSTALLED:
                    return BundleState::UNINSTALLED;
                case CELIX_BUNDLE_STATE_INSTALLED:
                    return BundleState::INSTALLED;
                case CELIX_BUNDLE_STATE_RESOLVED:
                    return BundleState::RESOLVED;
                case CELIX_BUNDLE_STATE_STARTING:
                    return BundleState::STARTING;
                case CELIX_BUNDLE_STATE_STOPPING:
                    return BundleState::STOPPING;
                case CELIX_BUNDLE_STATE_ACTIVE:
                    return BundleState::ACTIVE;
                default:
                    return BundleState::UNKNOWN;
            }
        }
 
        bool isSystemBundle() const {
            return celix_bundle_isSystemBundle(cBnd.get());
        }
 
        celix_bundle_t* getCBundle() const {
            return cBnd.get();
        }
    private:
        std::string getEntryInternal(const char* path) const {
            char* entry = celix_bundle_getEntry(cBnd.get(), path);
            return convertCStringToStdString(entry);
        }
 
        std::string getDataFileInternal(const char* path) const {
            char* entry = celix_bundle_getDataFile(cBnd.get(), path);
            return convertCStringToStdString(entry);
        }
 
        std::string convertCStringToStdString(char* str) const {
            std::unique_ptr<char, void(*)(void*)> strGuard{str, free};
            return std::string{str == nullptr ? "" : str};
        }
 
        const std::shared_ptr<celix_bundle_t> cBnd;
    };
}