Writing language definition files - Revision history

OlivierSessink: /* auto completion */

2023-01-05T16:54:06Z

auto completion

← Older revision		Revision as of 16:54, 5 January 2023
Line 398:		Line 398:
	<pre>		<pre>
	<tag name="img" attributes="style,class,id,src,width,height"		<tag name="img" attributes="style,class,id,src,width,height"
	attrib_autocomplete_append="=&quot;&quot;" attrib_autocomplete_backup_cursor="2"/></pre>		attrib_autocomplete_append="=&quot;&quot;" attrib_autocomplete_backup_cursor="2">
			<autocomplete append=" src=&dquot;&dquot; " />
			</tag>
			</pre>

	a <tag> automatically autocompletes. it also has an 'attrib_autocomplete_append' atribute.		a <tag> automatically autocompletes. it also has an 'attrib_autocomplete_append' atribute.

OlivierSessink: /* auto completion */

2023-01-05T16:47:56Z

auto completion

← Older revision		Revision as of 16:47, 5 January 2023
Line 398:		Line 398:
	<pre>		<pre>
	<tag name="img" attributes="style,class,id,src,width,height"		<tag name="img" attributes="style,class,id,src,width,height"
	~~autocomplete_append=">"~~ attrib_autocomplete_append="=&quot;&quot;" attrib_autocomplete_backup_cursor="2"/></pre>		attrib_autocomplete_append="=&quot;&quot;" attrib_autocomplete_backup_cursor="2"/></pre>

	a <tag> automatically autocompletes. it also has an 'attrib_autocomplete_append' atribute.		a <tag> automatically autocompletes. it also has an 'attrib_autocomplete_append' atribute.

OlivierSessink: /* The tag tag in the definition section */

2023-01-05T16:46:54Z

The tag tag in the definition section

← Older revision		Revision as of 16:46, 5 January 2023
Line 388:		Line 388:
	</context>		</context>
	</element>		</element>
	<element pattern="</body<" highlight="tag" ends_block="1" blockstartelement="<body" />		<element pattern="</body>" highlight="tag" ends_block="1" blockstartelement="<body" />
	</pre>		</pre>

OlivierSessink: /* The element tag in the definition section */

2019-04-12T18:09:29Z

The element tag in the definition section

← Older revision		Revision as of 18:09, 12 April 2019
Line 249:		Line 249:
	it always needs attribute 'pattern' which defines the pattern that will be looked for in this context		it always needs attribute 'pattern' which defines the pattern that will be looked for in this context

			a pattern may be case insensitive, set case_insens="1"

			to highlight the pattern use attribute highlight="TYPE", where TYPE should be defined within the <header>
			section of the language file

			==== Limited regular expression support ====
	the pattern can be defined in 'regular expression' style, to do this add attribute is_regex="1". however, there is		the pattern can be defined in 'regular expression' style, to do this add attribute is_regex="1". however, there is
	only limited regular expression support. ~~you~~ may use		only limited regular expression support. You may use
	* a range of characters such as [a-z0-9;']		* a range of characters such as [a-z0-9;']
	* an inverted range such as [^0-9]		* an inverted range such as [^0-9]
Line 256:		Line 262:
	* subpatterns such as ab(fg)?		* subpatterns such as ab(fg)?
	* the OR construction (foo\|bar), but only within round braces		* the OR construction (foo\|bar), but only within round braces

			Another limitation is that overlapping regular expressions result in undefined behavior. For example a construction like ([a-z]+p) will not work because p is part of the [a-z]+ so bluefish does not know when scanning a p if it is part of the [a-z]+ or it is the final p.

	<pre><element pattern="'[^']*'" is_regex="1" highlight="string"/></pre>		<pre><element pattern="'[^']*'" is_regex="1" highlight="string"/></pre>

	~~a pattern may be case insensitive, set case_insens="1"~~

	~~to highlight the pattern use attribute highlight="TYPE", where TYPE should be defined within the <header>~~
	~~section of the language file~~
	==== Element re-use ====		==== Element re-use ====
	<element> may have attribute 'id' so this element may be referred to later. To re-use element 'foo' later in the file use		<element> may have attribute 'id' so this element may be referred to later. To re-use element 'foo' later in the file use

OlivierSessink: /* The element tag in the definition section */

2019-04-12T17:39:54Z

The element tag in the definition section

← Older revision		Revision as of 17:39, 12 April 2019
Line 251:		Line 251:
	the pattern can be defined in 'regular expression' style, to do this add attribute is_regex="1". however, there is		the pattern can be defined in 'regular expression' style, to do this add attribute is_regex="1". however, there is
	only limited regular expression support. you may use		only limited regular expression support. you may use
	- a range of characters such as [a-z0-9;']		* a range of characters such as [a-z0-9;']
	- an inverted range such as [^0-9]		* an inverted range such as [^0-9]
	- operators such as ? (zero or one), + (one or more), and * (zero or more)		* operators such as ? (zero or one), + (one or more), and * (zero or more)
	- subpatterns such as ab(fg)?		* subpatterns such as ab(fg)?
			* the OR construction (foo\|bar), but only within round braces

	<pre><element pattern="'[^']*'" is_regex="1" highlight="string"/></pre>		<pre><element pattern="'[^']*'" is_regex="1" highlight="string"/></pre>

OlivierSessink: /* hardcoded option names */

2016-01-15T10:20:23Z

hardcoded option names

← Older revision		Revision as of 10:20, 15 January 2016
Line 93:		Line 93:
	The following example starts a PHP open tag, but only if the file is being included in the PHP language:		The following example starts a PHP open tag, but only if the file is being included in the PHP language:
	<group class="is_PHP"><element idref="e.php.short.open" /></group>		<group class="is_PHP"><element idref="e.php.short.open" /></group>
			See more about this in the section '''Advanced group class/notclass values'''

	There are also a few global options that are hardcoded:		There are also a few global options that are hardcoded:

OlivierSessink: /* groups that can be disabled/enabled with an option */

2016-01-15T10:19:34Z

groups that can be disabled/enabled with an option

← Older revision		Revision as of 10:19, 15 January 2016
Line 480:		Line 480:
	</group>		</group>
	</pre>		</pre>
	~~The hardcoded option 'is_<language name>' can be useful in an include file that is included in multiple languages. See the section on hardcoded option names.~~

	==== Advanced group class/notclass values ====		==== Advanced group class/notclass values ====

OlivierSessink: /* groups that can be disabled/enabled with an option */

2016-01-15T10:19:17Z

groups that can be disabled/enabled with an option

← Older revision		Revision as of 10:19, 15 January 2016
Line 480:		Line 480:
	</group>		</group>
	</pre>		</pre>
			The hardcoded option 'is_<language name>' can be useful in an include file that is included in multiple languages. See the section on hardcoded option names.

	==== Advanced group class/notclass values ====		==== Advanced group class/notclass values ====

OlivierSessink: /* Block detection */

2016-01-15T10:17:48Z

Block detection

← Older revision		Revision as of 10:17, 15 January 2016
Line 279:		Line 279:
	Because this block has a name ('Bracket block') it can be selected by the user in the		Because this block has a name ('Bracket block') it can be selected by the user in the
	expand/collapse popup menu. You can also create an option 'Bracket block_foldable' in the header options so		expand/collapse popup menu. You can also create an option 'Bracket block_foldable' in the header options so
	the user may decide if this block may fold or not. If you don't need either the		the user may decide if this block may fold or not. See also the section on hardcoded option names. If you don't need either the
	block_name can be left empty.		block_name can be left empty.

OlivierSessink: /* hardcoded option names */

2016-01-15T10:16:59Z

hardcoded option names

← Older revision		Revision as of 10:16, 15 January 2016
Line 85:		Line 85:
	==== hardcoded option names ====		==== hardcoded option names ====

	There are a few special (hardcoded) option names:		There are a few special (hardcoded) option names that can be used in the language file:

	In the next example a block named 'php block' is made optionally foldable (or not). Read more about block detection in the <element /> section~~. The '_foldable' suffix is hardcoded in bluefish~~.		The '_foldable' suffix is hardcoded in bluefish. It should be followed by block_name that is used in the language file somewhere. The attribute block_name can be in an <element> tag. In the next example a block named 'php block' is made optionally foldable (or not). Read more about block detection in the <element /> section.
	<pre><option name="php block_foldable" default="1" description="Allow the PHP block to fold"/></pre>		<pre><option name="php block_foldable" default="1" description="Allow the PHP block to fold"/></pre>

			The 'is_' suffix is hardcoded in bluefish. It should be followed by the language name. This is useful for include files that are included in several different languages. This option is not set by the user, it is always present during compilation.
			The following example starts a PHP open tag, but only if the file is being included in the PHP language:
			<group class="is_PHP"><element idref="e.php.short.open" /></group>

			There are also a few global options that are hardcoded:

	Whether or not to load the reference data for this language (saves memory)		Whether or not to load the reference data for this language (saves memory)