datatype.h

/*******************************************************************************
 * Copyright (C) 2015-2019 Commissariat a l'energie atomique et aux energies alternatives (CEA)
 * Copyright (C) 2020-2021 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of CEA nor the names of its contributors may be used to
 *   endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/

#ifndef PDI_DATATYPE_H_
#define PDI_DATATYPE_H_

#include <memory>
#include <string>
#include <utility>
#include <vector>

#include <pdi/pdi_fwd.h>
#include <pdi/datatype_template.h>


namespace PDI {

class PDI_EXPORT Datatype:
    public Datatype_template
{
public:
    struct Accessor_base {
        virtual std::pair<void*, Datatype_uptr> access(const Array_datatype& type,
            void* from,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_begin,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_end) const;
            
        virtual std::pair<void*, Datatype_uptr> access(const Pointer_datatype& type,
            void* from,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_begin,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_end) const;
            
        virtual std::pair<void*, Datatype_uptr> access(const Record_datatype& type,
            void* from,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_begin,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_end) const;
            
        virtual std::string access_kind() const = 0;
        
        virtual std::unique_ptr<Accessor_base> clone() const = 0;
        
        virtual ~Accessor_base() = default;
    };
    
    Datatype(const Attributes_map& attributes = {});
    
    ~Datatype() override;
    
    virtual Datatype_uptr clone_type() const = 0;
    
    virtual bool operator== (const Datatype& other) const = 0;
    
    bool operator!=(const Datatype& other) const;
    
    virtual Datatype_uptr densify() const = 0;
    
    virtual bool dense() const = 0;
    
    virtual size_t datasize() const = 0;
    
    virtual size_t buffersize() const = 0;
    
    virtual size_t alignment() const = 0;
    
    virtual bool simple() const = 0;
    
    virtual void* data_to_dense_copy(void* to, const void* from) const = 0;
    
    virtual void* data_from_dense_copy(void* to, const void* from) const = 0;
    
    std::pair<void*, Datatype_uptr> subaccess(void* from, const Accessor_base& accessor) const;
    
    std::pair<void*, Datatype_uptr> subaccess(void* from, const std::vector<std::unique_ptr<Accessor_base>>& accessors) const;
    
    virtual std::pair<void*, Datatype_uptr> subaccess_by_iterators(void* from,
        std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_begin,
        std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_end) const;
        
    virtual void destroy_data(void* ptr) const = 0;
    
    virtual std::string debug_string() const = 0;
    
};

} // namespace PDI

#endif // PDI_DATATYPE_H_