elemLoader.h

// Copyright 2009-2026 NTESS. Under the terms
// of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// Copyright (c) 2009-2026, NTESS
// All rights reserved.
//
// This file is part of the SST software package. For license
// information, see the LICENSE file in the top level directory of the
// distribution.
 
#ifndef SST_CORE_ELEMLOADER_H
#define SST_CORE_ELEMLOADER_H
 
#include <ostream>
#include <string>
#include <vector>
 
namespace SST {
 
struct ElementInfoGenerator;
 
/** Class to load Element Libraries */
class ElemLoader
{
public:
    /** Create a new ElementLoader with a given searchpath of directories */
    explicit ElemLoader(const std::string& searchPaths);
    ~ElemLoader() = default;
 
    /**
       Update the search paths
       @param searchPaths New search paths to use
     */
    void updateSearchPaths(const std::string& paths);
 
    /** Attempt to load a library
     * @param elemlib - The name of the Element Library to load
     * @param err_os - Where to print errors associated with attempting to find and load the library
     * @return Informational structure of the library, or nullptr if it failed to load.
     */
    void loadLibrary(const std::string& elemlib, std::ostream& err_os);
 
    /**
     * Search paths for potential elements and add them to the provided vector
     *
     * @param potElems - vector of potential elements that could contain elements
     * @return void
     */
    void getPotentialElements(std::vector<std::string>& potElems);
 
private:
    std::string searchPaths;
    bool        verbose;
    int         bindPolicy;
};
 
} // namespace SST
 
#endif // SST_CORE_ELEMLOADER_H