.. 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:

Overview
~~~~~~~~




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

	#include <syntaxdefinition.hpp>
	
	class SyntaxDefinition {
	public:
		// 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_1a493cf6d057f37c99310841c0a63627ab>`(
			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:`UnorderedMap<doxid-namespace_e_e_1aa78282d5922baa5e06c4de9ffe040581>`<std::string, std::string>&& symbols = {},
			const std::string& comment = "",
			std::vector<std::string>&& headers = {},
			const std::string& lspName = ""
		);

		// 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 :ref:`String::HashType<doxid-class_e_e_1_1_string_1a105c2ab365f2a3085c714617f129b386>`& :target:`getLanguageId<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1a3352ddb10a788254290f60e1b9af155b>`() 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:`UnorderedMap<doxid-namespace_e_e_1aa78282d5922baa5e06c4de9ffe040581>`<std::string, :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_1aaf52dd074c0e3244bd2e1011602909f9>`() 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_1a4710c05005349f0ed9457769e3468503>`(const std::string& 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_1aa542514d7db52ad553c9583ce883e970>`(const :ref:`UnorderedMap<doxid-namespace_e_e_1aa78282d5922baa5e06c4de9ffe040581>`<std::string, :ref:`SyntaxStyleType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a6c84b2e504b7f4dae59909e4181e4bf0>`>& symbols);
		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>`();
		void :target:`clearSymbols<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1abaff46cf713428989089903726f5db7b>`();
		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:`UnorderedMap<doxid-namespace_e_e_1aa78282d5922baa5e06c4de9ffe040581>`<std::string, std::string> :target:`getSymbolNames<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_syntax_definition_1aaee17fd988991da11698d3bfcbc59344>`() 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);
	};
.. _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.