class EE::UI::Doc::SyntaxDefinitionManager

Overview

#include <syntaxdefinitionmanager.hpp>

class SyntaxDefinitionManager {
public:
    // typedefs

    typedef std::unordered_map<std::string, std::string> FileAssociations;

    // methods

    static SyntaxDefinitionManager* createSingleton(std::size_t reserveSpaceForLanguages);
    static std::pair<std::string, std::string> toCPP(const SyntaxDefinition& def);
    std::size_t count() const;
    void addPreDefinition(SyntaxPreDefinition&& preDefinition);
    SyntaxDefinition& add(SyntaxDefinition&& syntaxStyle);
    const SyntaxDefinition& getPlainDefinition() const;
    std::shared_ptr<SyntaxDefinition> getPlainDefinitionPtr() const;
    std::vector<const SyntaxDefinition*> languagesThatSupportExtension(std::string extension) const;
    bool extensionCanRepresentManyLanguages(std::string extension) const;
    const SyntaxDefinition& getByExtension(const std::string& filePath) const;
    const SyntaxDefinition& getByPath(const std::string& filePath) const;
    const SyntaxDefinition& getByFileAssociations(const std::string& filePath) const;
    const SyntaxDefinition& getByHeader(std::string_view header, const std::string& filePath = "", HExtLanguageType hLangType = HExtLanguageType::AutoDetect) const;
    const SyntaxDefinition& find(const std::string& filePath, std::string_view header, HExtLanguageType hLangType = HExtLanguageType::AutoDetect);
    std::shared_ptr<SyntaxDefinition> getLanguageDefinition(const Uint32& index) const;
    std::shared_ptr<SyntaxDefinition> findPtr(const std::string& filePath, std::string_view header, HExtLanguageType hLangType = HExtLanguageType::AutoDetect);
    const SyntaxDefinition& findFromString(const std::string_view& str) const;
    SyntaxDefinition& getByExtensionRef(const std::string& filePath);
    const SyntaxDefinition& getByLanguageName(const std::string_view& name) const;
    const SyntaxDefinition& getByLanguageIndex(const Uint32& index) const;
    const SyntaxDefinition& getByLanguageNameInsensitive(const std::string_view& name) const;
    const SyntaxDefinition& getByLSPName(const std::string_view& name) const;
    std::vector<std::string> getLanguageNames() const;
    std::vector<std::string> getExtensionsPatternsSupported() const;
    std::vector<std::string> getFileExtensions() const;
    const SyntaxDefinition* getPtrByLSPName(const std::string& name) const;
    bool loadFromStream(IOStream& stream, std::vector<std::string>* addedLangs);
    bool loadFromStream(IOStream& stream);
    bool loadFromFile(const std::string& fpath);
    bool loadFromMemory(const Uint8* data, const Uint32& dataSize);
    bool loadFromPack(Pack* Pack, const std::string& filePackPath);
    void loadFromFolder(const std::string& folderPath);
    bool save(const std::string& path, const std::vector<SyntaxDefinition>& def = {});
    void setLanguageExtensionsPriority(const std::map<std::string, std::string>& priorities);
    const std::map<std::string, std::string>& getLanguageExtensionsPriority();
    bool isFileFormatSupported(const std::string& filePath, std::string_view header);
    void resetFileAssociations();
    void setFileAssociations(FileAssociations&& fa);
    FileAssociations getFileAssociations() const;

    template <typename Fn>
    void forEachDefinition(Fn cb);

    template <typename Fn>
    void forEachPreDefinition(Fn cb);
};

Detailed Documentation

Methods

std::vector<std::string> getFileExtensions() const

Returns the literal filename extensions declared by syntax definitions. Filename-only patterns and patterns that cannot be represented as extensions are omitted.