Extension:SQFHighlighter

From Bohemia Interactive Community
Revision as of 12:24, 2 November 2023 by Lou Montana (talk | contribs) (Add comment formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
SQF Highlighter
Description Highlights and links SQF commands and functions
Author Lou Montana
Project Start 2022-03-08: Project start
Release Date
  • 2022-03-12: "v1" (0.50b), first upload
  • 2022-07-11: "v2" (0.85b), new parser
  • 2023-11-02: 0.9b, allow some wiki formatting in comments
Version 0.9b

This extension highlights and automatically links SQF commands and functions. It also covers SQS (free of charge).


Features

  • SQF Syntax support
  • SQS Syntax support
  • "Copy code to clipboard" button on hover
  • Partial wiki formatting in comments: ''italic'', '''bold''', <s>striked</s>, <u>underlined</u>, [[links|even styled ones]], {{templates}}
  • #defined constant value on mouse hover
  • SQF tag button in the wiki edit toolbar (next to B and I)
  • Options:
    • inline for inline code
    • notrim to remove the auto trim (lines themselves will always be rtrimmed)
  • Categorises wrong code pages in Category:Pages with SQF errors and Category:Pages with SQS errors


Installation

  • Unzip the directory to wiki/extensions/SQFHighlighter
  • Add wfLoadExtension( 'SQFHighlighter' ); to LocalSettings.php
  • there is a case-sensitive setting in extension.json (default true). Set to false to highlight improperly-cased commands and functions (e.g setDaMMage instead of setDammage, etc)
  • The extension creates full path links unless the host is one of the following (then relative links are created):
    • community.bistudio.com
    • community.bohemia.net


Usage

Using <sqf> tags will auto-generate syntax highlighting and links to the pages.

Examples
SQF Syntax
Code Result
<sqf/>
-no SQF code provided-
<sqf></sqf>
-no SQF code provided-
<sqf> </sqf>
-no SQF code provided-
<sqf>hint "It Works!";</sqf>
hint "It Works!";
This is <sqf inline>hint "It Works!";</sqf> absolutely inline.
This is hint "It Works!"; absolutely inline.
<sqf notrim>

	hint "It Works!";


</sqf>
hint "It Works!";
<sqf>
// your code here
hint "good!";
</sqf>
// your code here hint "good!";
<sqf>
#define fadeInDuration 3

waitUntil { not alive player };
hint DEATH_MESSAGE;
cutText ["", "Black", playerRespawnTime];

private _deathTime = time;
Deaths = Deaths + 1;

/*
	wait for resurrection - see {{Link|Arma 3: Respawn}}
*/
waitUntil { alive player && { preloadCamera getPosATL player } };

sleep 3;
cutText ["Welcome!", "Black in", fadeInDuration];

// after 10s, end the mission
sleep 10;
[] call BIS_fnc_endMission;
</sqf>
#define fadeInDuration 3 waitUntil { not alive player }; hint DEATH_MESSAGE; cutText ["", "Black", playerRespawnTime]; private _deathTime = time; Deaths = Deaths + 1; /* wait for resurrection - see Arma 3: Respawn */ waitUntil { alive player && { preloadCamera getPosATL player } }; sleep 3; cutText ["Welcome!", "Black in", fadeInDuration]; // after 10s, end the mission sleep 10; [] call BIS_fnc_endMission;
SQS Syntax
Code Result
<sqs/>
-no SQS code provided-
<sqs></sqs>
-no SQS code provided-
<sqs> </sqs>
-no SQS code provided-
<sqs>hint "It Works!"</sqs>
hint "It Works!";
This is <sqs inline>hint "It Works!"</sqs> absolutely inline.
This is hint "It Works!" absolutely inline.
<sqs notrim>

	hint "It Works!";


</sqs>
hint "It Works!";
<sqs>
#loop
@ alive player
; you ok - see [[getDammage]] too
hint "OK"
~1
@ not alive player
~1
hint "you ded"
; you not ok
goto "loop"
</sqs>
#loop @ alive player ; you ok - see getDammage too hint "OK" ~1 @ not alive player ~1 hint "you ded" ; you not ok goto "loop"


CSS Classes

All elements are <span> except for some exceptions:

  • unless using <sqf inline>, the parent block is a <div> holding another one for scrolling purpose; otherwise, is is a <span> as well.
Element CSS class Overview
parent block sqfhighlighter-block
contains sqfhighlighter-scroller for blocks
;
error message sqfhighlighter-error
-no SQF code provided-

-no SQS code provided-
wild character / bad variable / unclosed string bv, bvl
@ private _var = 3RndMag; hint "hello
comment cc
// comment /* this is a multiline comment */
comment bold b
// bold comment
string s
"string"
stringtable string ss
"STR_entry" "str_entry" "sTr_entry" "STRD_entry" "STRM_entry" "$STR_entry"
number n
42 -6.9 10e10
operator o
a + b
keyword (if, then, waitUntil, etc) k
command c
function f
function (external) fe
// not just considering BIS_ or BIN_ BIS_fnc_unknownFunction TAG_fnc_spawnGroup
local variable lv
_localVar
global variable gv
// anything will go but UNDERSCORED_ALL_CAPS GlobalVar = 1;
macro m
#define myVar 1 #if #endif
constant (#defined value) c
// anything #defined only #define testVar 1 testVar; otherVar; MY_CONSTANT;
array start ([) as
[ /* ... */
array end (]) ae
/* ... */ ]
code start ({) cs
{ /* ... */
code end (}) ce
/* ... */ }
parenthese start ({) ps
( /* ... */
parenthese end (}) pe
/* ... */ )


Known Issues

Version Issue Report Date Fix Date
v1 comment blocks still highlight words as global variables for now 2022-03-15 2022-03-17
#if are considered as keywords 2022-03-15 2022-03-17
single-quote strings have issues with other formatting between quotes 2022-03-15 w/ v2
negative numbers should see the minus sign coloured as well
in the end, they should not
2022-03-15 2022-03-17
numbers in variables are highlighted as numbers (e.g unit1) 2022-03-22 w/ v2
v2 preprocessor instructions are not considered if not at the very beginning of the line (and the parsing of the whole line may be wrong) 2022-07-11 2022-07-12
Report issues on Discord, in the #community_wiki channel!