.. index:: pair: class; EE::UI::Doc::SyntaxDefinition
.. _doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition:

class EE::UI::Doc::SyntaxDefinition
===================================

.. toctree::
	:hidden:

	struct_EE_UI_Doc_SyntaxDefinition_BlockComment.rst

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <syntaxdefinition.hpp>
	
	class SyntaxDefinition {
	public:
		// structs
	
		struct :ref:`BlockComment<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1_1_block_comment>`;

		// construction
	
		:target:`SyntaxDefinition<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a6ef2fa4c1060b819bc8698509df8a785>`();
	
		:target:`SyntaxDefinition<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ac911765f4287652af35b22435915241c>`(
			const std::string& languageName,
			std::vector<std::string>&& files,
			std::vector<:ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`>&& patterns,
			:ref:`SyntaxDefMap<doxid-namespace_e_e_1_1_u_i_1_1_doc_1aaaa682e4718e9980c71acf17ba259a5d>`<std::string, std::string>&& symbols = {},
			const std::string& comment = "",
			std::vector<std::string>&& headers = {},
			const std::string& lspName = "",
			std::vector<std::pair<std::string, std::vector<:ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`>>>&& repositories = {},
			:ref:`BlockComment<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1_1_block_comment>`&& blockComment = {}
		);

		// methods
	
		const std::string& :target:`getLanguageName<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ab3a2bc68bedfeea7f7fe5a525f27625b>`() const;
		std::string :target:`getLanguageNameForFileSystem<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1aa8b65365cbd387691d8d0ef46514f3ca>`() const;
		const std::vector<std::string>& :target:`getFiles<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a728cebd05817c066bb0ef4226d493299>`() const;
		std::string :target:`getFileExtension<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1aba3cdc791512ce1f0761a28ef3871906>`() const;
		const std::vector<:ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`>& :target:`getPatterns<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ab5a93e884f691411cd2dd3df9063ea4b>`() const;
		const std::string& :target:`getComment<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ac326f6193ba1d7111f3758c6f6627404>`() const;
		const :ref:`SyntaxDefMap<doxid-namespace_e_e_1_1_u_i_1_1_doc_1aaaa682e4718e9980c71acf17ba259a5d>`<:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`, :ref:`SyntaxStyleType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a6c84b2e504b7f4dae59909e4181e4bf0>`>& :target:`getSymbols<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a5b55686b47d5bf48c549ef43bdefebdf>`() const;
		:ref:`SyntaxStyleType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a6c84b2e504b7f4dae59909e4181e4bf0>` :target:`getSymbol<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a8ec8fb493340be96e5b3c358eb8a9456>`(std::string_view symbol) const;
		SyntaxDefinition& :ref:`addFileType<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a9e00a5e2992dff7951379a59df030b91>`(const std::string& fileType);
		SyntaxDefinition& :target:`addPattern<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a8de88f3c32e9897fec97e7ae0d0d24e3>`(const :ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`& pattern);
		SyntaxDefinition& :target:`setPatterns<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a17a62fc54340941286f6c4f22d882dd1>`(const std::vector<:ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`>& patterns);
		SyntaxDefinition& :target:`addPatternToFront<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1aa27760716162c0e74131e4ec2e0ecb17>`(const :ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`& pattern);
		SyntaxDefinition& :target:`addPatternsToFront<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ad8936049b6f9bd0ee163ce0f51ffe404>`(const std::vector<:ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`>& patterns);
		SyntaxDefinition& :target:`addSymbol<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a5e3e9b1ab08ffccebe382f28c11e63da>`(const std::string& symbolName, const std::string& typeName);
		SyntaxDefinition& :target:`addSymbols<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1aeac9dfe9c9e35c0d973abd6155ecab77>`(const std::vector<std::string>& symbolNames, const std::string& typeName);
		SyntaxDefinition& :target:`setSymbols<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1abb67941fdcb1918cec5ea1faa2ba2cb5>`(const :ref:`SyntaxDefMap<doxid-namespace_e_e_1_1_u_i_1_1_doc_1aaaa682e4718e9980c71acf17ba259a5d>`<:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`, :ref:`SyntaxStyleType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a6c84b2e504b7f4dae59909e4181e4bf0>`>& symbols, const :ref:`SyntaxDefMap<doxid-namespace_e_e_1_1_u_i_1_1_doc_1aaaa682e4718e9980c71acf17ba259a5d>`<std::string, std::string>& symbolNames);
		SyntaxDefinition& :ref:`setComment<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a6c18179390920e9c70c214ae74ad7d1e>`(const std::string& comment);
		const std::vector<std::string>& :target:`getHeaders<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a2c6a5ac566a0b0408dcb0110bb34ca92>`() const;
		SyntaxDefinition& :target:`setHeaders<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a58b7c17a8945915388018fa8decd404d>`(const std::vector<std::string>& headers);
		void :target:`clearPatterns<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a8ffa90b0d3eb2ef24342dc54f2412e8b>`();
		const std::string& :target:`getLSPName<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a3f86680d2901e9a24a53030998de4da2>`() const;
		SyntaxDefinition& :target:`setVisible<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ab3cfc906a41d2c24aa1c5b43904250f6>`(bool visible);
		bool :target:`isVisible<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a5bcdce8f5d82fe3209837278351067e3>`() const;
		bool :target:`getAutoCloseXMLTags<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a5bc74afb0971807ccce152a86637a444>`() const;
		SyntaxDefinition& :target:`setAutoCloseXMLTags<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a4226b8c6f59186a1dbaa51c7f88e30bb>`(bool autoCloseXMLTags);
		SyntaxDefinition& :target:`setLanguageName<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1aef53bfec40623887b1202d9941ea68c1>`(const std::string& languageName);
		SyntaxDefinition& :target:`setLSPName<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a581a333248dc27a9757ce3b2087401e0>`(const std::string& lSPName);
		std::vector<:ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`> :target:`getPatternsOfType<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a9875fad6272f13d3f765195b16220ab6>`(const :ref:`SyntaxStyleType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a6c84b2e504b7f4dae59909e4181e4bf0>`& type) const;
		SyntaxDefinition& :target:`setFileTypes<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a09f5d232af4dab54093d7997e2dc70a2>`(const std::vector<std::string>& types);
		bool :target:`hasExtensionPriority<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a554d059b5dc57b2da8b37076ed504705>`() const;
		SyntaxDefinition& :target:`setExtensionPriority<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a66bf8824c5f3fce4e358b605f9db739b>`(bool hasExtensionPriority);
		:ref:`SyntaxDefMap<doxid-namespace_e_e_1_1_u_i_1_1_doc_1aaaa682e4718e9980c71acf17ba259a5d>`<std::string, std::string> :target:`getSymbolNames<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a1727531b8fa109e43841f3f0789626e6>`() const;
		const :ref:`Uint16<doxid-namespace_e_e_1ae232c183cc9a0c087663cd838c93f0fc>`& :target:`getLanguageIndex<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a1ccc4ea332807dcbff2ee2ef6edb1b3d>`() const;
		bool :target:`isCaseInsensitive<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a05fd8337c64287cdc53ebde6edb5e011>`() const;
		SyntaxDefinition& :target:`setCaseInsensitive<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a3f96df42374516c71565eb409ef94588>`(bool caseInsensitive);
		:ref:`FoldRangeType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a806b3f2b4f27db52021f0b162236e887>` :target:`getFoldRangeType<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a3e4d4ec8c97a1215ad13b2f11cbeff8f>`() const;
		SyntaxDefinition& :target:`setFoldRangeType<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ad92fd1fc53f815b31b18ca50aeac4820>`(:ref:`FoldRangeType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a806b3f2b4f27db52021f0b162236e887>` foldRangeType);
		std::vector<std::pair<:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>`, :ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>`>> :target:`getFoldBraces<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a4ea2e73029fb38b64b5a54b77a528cd8>`() const;
		SyntaxDefinition& :target:`setFoldBraces<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a69f0b7fb40f000b0ace71f64332651c6>`(const std::vector<std::pair<:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>`, :ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>`>>& foldBraces);
		SyntaxDefinition& :target:`addRepository<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a28f80684e6e64bcbe6971aaedbad9a08>`(std::string&& name, :ref:`SyntaxRepository<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_repository>`&& patterns);
		SyntaxDefinition& :target:`addRepositories<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a6a27de5cb9de2f552356d9a71582dcf6>`(std::vector<std::pair<std::string, std::vector<:ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`>>>&& repositories);
		const :ref:`SyntaxRepository<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_repository>`& :target:`getRepository<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a3a6e5781cb37e72c19e046b119fac283>`(:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>` hash) const;
		const :ref:`SyntaxRepository<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_repository>`& :target:`getRepository<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a088331607d6912b811907ed397280a39>`(std::string_view name) const;
		:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :target:`getRepositoryIndex<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a05107ed396c6c89afccb61189cb67895>`(:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>` hash) const;
		:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :target:`getRepositoryIndex<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a9cfebbda7dc947748df221c8f2128d76>`(std::string_view name) const;
		:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>` :target:`getRepositoryHash<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a775b1772687c584ab6af214acfc70721>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` index) const;
		std::string :target:`getRepositoryName<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ae0481801e65a0af5f0814486f8569ea8>`(:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>` hash) const;
		const :ref:`SyntaxDefMap<doxid-namespace_e_e_1_1_u_i_1_1_doc_1aaaa682e4718e9980c71acf17ba259a5d>`<:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`, :ref:`SyntaxRepository<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_repository>`>& :target:`getRepositories<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a02f048e5e3d0d49c6c4fd8835f5e23aa>`() const;
		const :ref:`SyntaxDefMap<doxid-namespace_e_e_1_1_u_i_1_1_doc_1aaaa682e4718e9980c71acf17ba259a5d>`<:ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`, std::string>& :target:`getRepositoriesNames<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1af161e559e4dd876e5e4fa128f518e47a>`() const;
		SyntaxDefinition& :target:`addAlternativeName<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a381143c55892a6bd6d208e91521b114c>`(const std::string& name);
		const std::vector<std::string>& :target:`getAlternativeNames<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a7eae53cb77a9439545c9b1f11de52d1f>`() const;
		const :ref:`SyntaxPattern<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_pattern>`* :target:`getPatternFromState<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1addae980251230f6f2dc07a806f819d99>`(const :ref:`SyntaxStateType<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_state_type>`& state) const;
		void :target:`compile<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a6e6752b583f13b731c0e1b7a5db9c501>`();
		SyntaxDefinition& :target:`setBlockComment<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1afb8a742a631344d0a7810d802b6a5185>`(:ref:`BlockComment<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1_1_block_comment>`&& blockComment);
		const :ref:`BlockComment<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1_1_block_comment>`& :target:`getBlockComment<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1ae12b5544e4a521da90cff9d9d0232432>`() const;
	};
.. _details-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Methods
-------

.. index:: pair: function; addFileType
.. _doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a9e00a5e2992dff7951379a59df030b91:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	SyntaxDefinition& addFileType(const std::string& fileType)

Accepts lua patterns and file extensions.

.. index:: pair: function; setComment
.. _doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a6c18179390920e9c70c214ae74ad7d1e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	SyntaxDefinition& setComment(const std::string& comment)

Sets the comment string used for auto-comment functionality.