Second Life Wiki - User contributions [en]

Category:LSL Integer

2016-06-24T15:02:12Z

Phil Metalhead: /* Examples */ added decimal test case, and signature

{{LSL Header|ml=*}}
{{LSLC|}}{{LSLC|Types}}

=Integers=
The integer data type is a signed 32 bit value between −2,147,483,648 and +2,147,483,647 (that is 0x80000000 to 0x7FFFFFFF in hex). Integers are whole numbers. The fractional datatype is the [[float]].

[[DEBUG_CHANNEL]] can be used as a constant for the maximum integer (for that is the value it is defined as).

==Examples==
All of the following are integers:
<source lang="lsl2">integer firstInt = 5512623;
integer secondInt = ACTIVE;
integer thirdInt = 0x61EC1A;
integer fourthInt = -160693;</source>

The following are NOT integers, use {{LSLG|float}} for them:
<source lang="lsl2">
integer decimalValue = 125.2; // ERROR : Type mismatch -- Integer literals can't have a decimal.
integer bigValue = 3147483647; // An undocumented way to say -1,147,483,649 // Integer literals can't be larger than 2,147,483,647.
integer biggerValue = 10123456789; // An undocumented way to say -1 // Integer literals can't be larger than 2,147,483,647.
</source>

The following function can be used to determine whether a string of characters consists only of integers. This can be important if you need to know that a user has entered a valid integer in chat or a textbox, for example.
<source lang="lsl2">
integer IsInteger(string var)
{
integer i;
for (i=0;i<llStringLength(var);++i)
{
if(!~llListFindList(["1","2","3","4","5","6","7","8","9","0"],[llGetSubString(var,i,i)]))
{
return FALSE;
}
}
return TRUE;
}</source>

Here's a simpler solution for strings containing positive or negative decimal integers (values from −2147483648 and 2147483647 written without + sign, leading zeros, or thousands separators ',' ). Omei Qunhua.

<source lang="lsl2">
if ( (string) ( (integer) data) == data)
llOwnerSay("'" + data + "' contains a valid integer");
</source>

The following examples will validate that a string contains only the characters 0 though 9. Omei Qunhua.

a) Example for a string of length 5
<source lang="lsl2">
StringOf5Dec(string test)
{
return ( (integer) ("1" + test) >= 100000);
}
</source>

b) Example for a string of length 1 through 9
<source lang="lsl2">
VarStringIsDecimal(string test)
{
integer limit = (integer) llPow(10.0, llStringLength(test) );
return ( (integer) ("1" + test) >= limit);
}
</source>

This function should validate any decimal integer, with or without signs or leading zeroes, and with leading/trailing space but does not accept thousands separators. (Phil Metalhead)

<source lang="lsl2">
integer uIsInteger(string input)
{
input = llStringTrim(input,STRING_TRIM); // remove leading/trailing whitespace
// "+123" is a valid integer string but would otherwise fail, so strip leading "+" if it's there
if (llGetSubString(input,0,0) == "+") input = llGetSubString(input,1,-1);
return ((string)((integer)input) == input);
}
</source>

Test cases for the above function (click "Expand" link on the right side of the page):
<source lang="lsl2" class="mw-collapsible mw-collapsed">
///////////////
// Returns 1 // (leading and trailing whitespace)
2352316

///////////////
// Returns 1 // (leading "+")
+151613662
///////////////
// Returns 1 // (negative number)
-263163626
///////////////
// Returns 1 // (largest positive integer)
2147483647
///////////////
// Returns 1 // (largest negative integer)
-2147483648
///////////////
// Returns 1 // (largest positive integer with leading and trailing whitespace, and leading "+")
+2147483647

///////////////
// Returns 0 // (contains letters)
161362stuff
///////////////
// Returns 0 // (number is a float, not an integer -- contains "." in string)
123.4
///////////////
// Returns 0 // (whitespace in middle of string)
2347
9089
///////////////
// Returns 0 // (contains thousands separator ",")
844,241
// Returns 0 // ("+" in middle of string)
2378+87668
///////////////
// Returns 0 // ("-" in middle of string)
3462098-12
// Returns 0 // (number > 2147483647)
2147483648
///////////////
// Returns 0 // (number < -2147483648)
-2147483649
///////////////
</source>

==Further Reading==
For a more extensive coverage of integers, including the different ways they are used in LSL, see [[LSL_101/LSL_in_Focus:_Integers|LSL in Focus: Integers]].

Category:LSL Integer

2016-06-24T14:59:12Z

Phil Metalhead: /* Examples */ Added integer test function

{{LSL Header|ml=*}}
{{LSLC|}}{{LSLC|Types}}

=Integers=
The integer data type is a signed 32 bit value between −2,147,483,648 and +2,147,483,647 (that is 0x80000000 to 0x7FFFFFFF in hex). Integers are whole numbers. The fractional datatype is the [[float]].

[[DEBUG_CHANNEL]] can be used as a constant for the maximum integer (for that is the value it is defined as).

==Examples==
All of the following are integers:
<source lang="lsl2">integer firstInt = 5512623;
integer secondInt = ACTIVE;
integer thirdInt = 0x61EC1A;
integer fourthInt = -160693;</source>

The following are NOT integers, use {{LSLG|float}} for them:
<source lang="lsl2">
integer decimalValue = 125.2; // ERROR : Type mismatch -- Integer literals can't have a decimal.
integer bigValue = 3147483647; // An undocumented way to say -1,147,483,649 // Integer literals can't be larger than 2,147,483,647.
integer biggerValue = 10123456789; // An undocumented way to say -1 // Integer literals can't be larger than 2,147,483,647.
</source>

The following function can be used to determine whether a string of characters consists only of integers. This can be important if you need to know that a user has entered a valid integer in chat or a textbox, for example.
<source lang="lsl2">
integer IsInteger(string var)
{
integer i;
for (i=0;i<llStringLength(var);++i)
{
if(!~llListFindList(["1","2","3","4","5","6","7","8","9","0"],[llGetSubString(var,i,i)]))
{
return FALSE;
}
}
return TRUE;
}</source>

Here's a simpler solution for strings containing positive or negative decimal integers (values from −2147483648 and 2147483647 written without + sign, leading zeros, or thousands separators ',' ). Omei Qunhua.

<source lang="lsl2">
if ( (string) ( (integer) data) == data)
llOwnerSay("'" + data + "' contains a valid integer");
</source>

The following examples will validate that a string contains only the characters 0 though 9. Omei Qunhua.

a) Example for a string of length 5
<source lang="lsl2">
StringOf5Dec(string test)
{
return ( (integer) ("1" + test) >= 100000);
}
</source>

b) Example for a string of length 1 through 9
<source lang="lsl2">
VarStringIsDecimal(string test)
{
integer limit = (integer) llPow(10.0, llStringLength(test) );
return ( (integer) ("1" + test) >= limit);
}
</source>

This function should validate any decimal integer, with or without signs or leading zeroes, and with leading/trailing space (does not accept thousands separators):

<source lang="lsl2">
integer uIsInteger(string input)
{
input = llStringTrim(input,STRING_TRIM); // remove leading/trailing whitespace
// "+123" is a valid integer string but would otherwise fail, so strip leading "+" if it's there
if (llGetSubString(input,0,0) == "+") input = llGetSubString(input,1,-1);
return ((string)((integer)input) == input);
}
</source>

Test cases (click "Expand" link on the right side of the page):
<source lang="lsl2" class="mw-collapsible mw-collapsed">
///////////////
// Returns 1 // (leading and trailing whitespace)
2352316

///////////////
// Returns 1 // (leading "+")
+151613662
///////////////
// Returns 1 // (negative number)
-263163626
///////////////
// Returns 1 // (largest positive integer)
2147483647
///////////////
// Returns 1 // (largest negative integer)
-2147483648
///////////////
// Returns 1 // (largest positive integer with leading and trailing whitespace, and leading "+")
+2147483647

///////////////
// Returns 0 // (contains letters)
161362stuff
///////////////
// Returns 0 // (whitespace in middle of string)
2347
9089
///////////////
// Returns 0 // (contains thousands separator ",")
844,241
// Returns 0 // ("+" in middle of string)
2378+87668
///////////////
// Returns 0 // ("-" in middle of string)
3462098-12
// Returns 0 // (number > 2147483647)
2147483648
///////////////
// Returns 0 // (number < -2147483648)
-2147483649
///////////////
</source>

==Further Reading==
For a more extensive coverage of integers, including the different ways they are used in LSL, see [[LSL_101/LSL_in_Focus:_Integers|LSL in Focus: Integers]].

ZZText

2016-04-18T20:40:42Z

Phil Metalhead: /* Mega-image maker python-fu script */ updated for proper code tag ~

== What is it ==

Scripting tools to allow display of text on a prim: [[XyText 1.5]] (aka XyText) , [[XyzzyText]], [[XyyyyzText]], [[XyzzyText-UTF8]], [[ZZText]], [[VariText]]

'''ZZText''' is a low-prim, low-lag, international variation of [[XyText]] with the following features:
* can be enhanced with new fonts or UTF-8 characters using GIMP and python-fu.
* uses only 35 textures instead of 66 for the 10 chars on prim solution (this gives a bit less quality then the original xytext, but under normal situations is acceptable.

Rationale: if you have problems with prim usage, then you can accept this compromise.

* this particular combination of textures gives something way more rapid than [[XyzzyText]], which is very slow for big boards, and less lagger than [[XyText]].
* small warning: there is still some slight improvements for this zzText to be reasonably acceptable (consider it in a Beta stage), will post soon when it will be fully acceptable.

== Credits and copyright ==
ZZText is heavily dependent on [[XyText]] so it shares and extends credits and copyrights.

Also this is a low prim variation of the [[XyzzyText-UTF8]] page but downgraded to use XyText lower quality paradigm instead than the 1 character face approach.

== How to generate the textures ==

* GIMP 2.8 has already python-fu installed so you don't need to bother on installing it as I suggested some years ago
* Use the mega-image maker python-fu script (see following sections)
* Use the splitter python-fu script to produce 512x512 guides for later splitting
* Use the filter/web/slice... button to produce 64 slices in png format to retain transparence (from 0-0 to 7-7)
* Manually remove the empty slices (the i-j where j>i for instance 2-3, 6-7) so you have only 35 images png.
* Manually convert each png to tga (this is solving some problems with sl uploading regarding transparence)
* Upload the textures keeping the order 0-0 1-0 1-1 2-0 2-1 2-3 .... until 7-7)

Manual parts can be automated by another python-fu, but I was so exhausted with the others that it was ok for me doing manually :)

There is still some fix needed to do on the python-fu script. Currently characters are still a bit unevenly put so that when displaying them
depending on which couple using we might see some slight asymmetric unbalancing. You can note this only when looking very closely to the chars.
Whenever I fix myself this problem I will post here.

For those of you who already accept fonts I did last week, look at next sections for the 35 texture UUIDs:

== So how can I use it? ==

* Put the script named ZZText into each prim of your board naming each cell 1000 ---- 1099 as far as you need cells
* Have a main script doing the following: llMessageLinked(LINK_SET,1040,"çòàùè",NULL_KEY) to write on cell named 1040

To divide in rows, use simple modulus operations.

== Variation on [[XyText 1.5]] standard script ==

For not being so difficult to follow, I only publish differences between my script and [[XyText 1.5]] so that you might be able to understand better what I did:
=== Change CHARACTER_GRID with our full permission textures ===
<lsl>
list CHARACTER_GRID = [
"96f4578b-879e-44ae-d223-427cc615f5a4", // my slice-0-0
"eab5360f-6653-593f-b679-69c68b0dd001", // 1-0
"367330be-717a-277d-5205-131cd6ded458", // 1-1
"32046675-6e7e-2425-ce77-69000b0b4d96", // 2-0
"40085901-bde6-2dd4-40cd-b6d48d242997", // 2-1
"205d318b-09b7-7ecc-922e-801c93a546c8", // 2-2
"841e7826-3645-d4f0-d48b-389586dd8e90", // 3-0
"e2db78c5-fb47-d767-4744-8cb6d84610d0", // 3-1
"15312c89-afd4-854c-9d9b-5b9e11844aed", // 3-2
"d180e771-0393-d09b-8cac-0af6d550ae4a", // 3-3
"c6c1d2c8-5dfd-b13a-7f1e-c3ede8126769", // 4-0
"bc100d0c-a445-947f-caa4-285d9cc8a9de", // 4-1
"0b31e862-75a4-9ed3-6331-e9e700a0fedb", // 4-2
"0eacc306-6bd5-ab31-de47-c686141a6733", // 4-3
"b68de1d9-4890-74a0-4d25-d4d5c83a0dba", // 4-4
"04b2bf9b-a8bb-0a39-1062-9b005229eba9", // 5-0
"be293f10-25ec-beb9-738b-fe1892b82aef", // 5-1
"5e9c8317-71f5-f073-76ab-7c412d3acb84", // 5-2
"030b441b-9022-2aba-f7a7-af6810c354b8", // 5-3
"9f455858-8ae6-3a9a-c2d4-bc5ee92430ac", // 5-4
"ee741143-f01e-f730-667e-66a3cd57d1cc", // 5-5
"710282bc-bd80-5a44-6987-0c4c11a4c294", // 6-0
"c9c410db-675a-1e98-4107-debd3c73a754", // 6-1
"486c2336-71c5-b962-266c-838a865c067c", // 6-2
"d4722155-0b6d-3673-0208-a727729bc117", // 6-3
"bc7af3cd-ee48-08df-fe8b-a6ca8a425733", // 6-4
"f23d7a73-00c3-1ffd-69a7-0cca031c939d", // 6-5
"aa95bfd1-ac80-f962-7acf-d6aeed9c7e81", // 6-6
"53fd52e3-0e8b-dcc8-42f8-332aef421bd2", // 7-0
"da3f6f09-3e3a-e156-8e2e-1040111a5635", // 7-1
"409a95c0-b685-2036-d0de-75e8ab654243", // 7-2
"14e05aca-3a61-b892-3632-dcde72324779", // 7-3
"546c0e4f-b678-895d-2035-0f39bb7f4979", // 7-4
"cf2fc337-109f-ba25-8ff5-786f7d6ceb5b", // 7-5
"9943204b-a4de-868a-3cdd-8785d1864ede", // 7-6
"765cfd9c-9703-b5ba-2c5d-f1c8bd44e0f4" // 7-7
];

</lsl>

=== Enabling answering to only a specific channel instead of DISPLAY_STRING channel ===
This heavily helps in producing multi cell boards:
<lsl>
integer ME;
default
{
state_entry()
{
// need that each cell has its own number as object name starting from 1000 for instance
ME = (integer)llGetObjectName();
}

// be sure we are answering only to channel ME
link_message(integer sender, integer channel, string data, key id)
{
if (channel == (ME)
{
RenderString(data);
return;
}
}
}
</lsl>

=== UTF-8 character specification ===
This must closely match what you produced with python-fu
<lsl>
ResetCharIndex() {
gCharIndex = " !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`";
// \" <-- Fixes LSL syntax highlighting bug.
gCharIndex += "abcdefghijklmnopqrstuvwxyz{|}~";
// cap cedille u: e/ a^ a: a/ a ring cedille e^ e:
decode= ["%C3%87", "%C3%BC", "%C3%A9", "%C3%A2", "%C3%A4", "%C3%A0", "%C3%A5", "%C3%A7", "%C3%AA", "%C3%AB",

// e\ i: i^ i\ A: A ring E/ ae AE marker >
"%C3%A8", "%C3%AF", "%C3%AE", "%C3%AC", "%C3%84", "%C3%85", "%C3%89", "%C3%A6", "%C3%86", "%E2%96%B6" ,

// o: o/ u^ u\ y: O: U: cent pound yen
"%C3%B6", "%C3%B2", "%C3%BB", "%C3%B9", "%C3%BF", "%C3%96", "%C3%9C", "%C2%A2", "%C2%A3", "%C2%A5",

// A^ a/ i/ o/ u/ n~ E: y/ inv ? O^
"%C3%82", "%C3%A1", "%C3%AD", "%C3%B3", "%C3%BA", "%C3%B1", "%C3%8B", "%C3%BD", "%C2%BF", "%C3%94",

// inv ! I\ I/ degree E^ I^ o^ U^
"%C2%A1", "%C3%8C", "%C3%8D", "%C2%B0", "%C3%8A", "%C3%8E", "%C3%B4", "%C3%9B",

// Y: euro german ss E\ A\ A/ U\ U/ O\ O/
"%C3%9D", "%E2%82%AC", "%C3%9F", "%C3%88", "%C3%80", "%C3%81", "%C3%99", "%C3%9A", "%C3%92", "%C3%93",

// Sv sv zv Zv Y: I:
"%C5%A0", "%C5%A1", "%C5%BE", "%C5%BD", "%C3%9D", "%C3%8C" ];

}
</lsl>

=== Accessing the new characters from textures ===
This is the most difficult part. Still need to clean up offsets, since now they are still a bit wrong.

<lsl>
vector GetGridOffset(vector grid_pos)
{
// Zoom in on the texture showing our character pair.
integer Col = llRound(grid_pos.x) % 40; // PK was 20
integer Row = llRound(grid_pos.y) % 20; // PK was 10

// Return the offset in the texture.
return <-0.45 + 0.025 * Col, 0.45 - 0.05 * Row, 0.0>; // PK was 0.05 and 0.1
}

ShowChars(vector grid_pos1, vector grid_pos2, vector grid_pos3, vector grid_pos4, vector grid_pos5)
{
// Set the primitive textures directly.

llSetLinkPrimitiveParamsFast(LINK_THIS, [
PRIM_TEXTURE, FACE_1, GetGridTexture(grid_pos1), <0.125, 0.05, 0>, GetGridOffset(grid_pos1) + <0.0375-0.025-0.002, 0.025, 0>, 0.0,
PRIM_TEXTURE, FACE_2, GetGridTexture(grid_pos2), <0.05, 0.05, 0>, GetGridOffset(grid_pos2)+<-0.025-0.002, 0.025,0>, 0.0,
PRIM_TEXTURE, FACE_3, GetGridTexture(grid_pos3), <-0.74, 0.05, 0>, GetGridOffset(grid_pos3)+ <-.34-0.002, 0.025, 0>, 0.0,
PRIM_TEXTURE, FACE_4, GetGridTexture(grid_pos4), <0.05, 0.05, 0>, GetGridOffset(grid_pos4)+<-0.025-0.002, 0.025,0>, 0.0,
PRIM_TEXTURE, FACE_5, GetGridTexture(grid_pos5), <0.125, 0.05, 0>, GetGridOffset(grid_pos5) + <0.0375-0.025-0.077-0.002, 0.025, 0>, 0.0

// PRIM_TEXTURE, FACE_1, GetGridTexture(grid_pos1), <0.25, 0.1, 0>, GetGridOffset(grid_pos1) + <0.075, 0, 0>, 0.0,
// PRIM_TEXTURE, FACE_2, GetGridTexture(grid_pos2), <0.1, 0.1, 0>, GetGridOffset(grid_pos2), 0.0,
// PRIM_TEXTURE, FACE_3, GetGridTexture(grid_pos3), <-1.48, 0.1, 0>, GetGridOffset(grid_pos3)+ <0.37, 0, 0>, 0.0,
// PRIM_TEXTURE, FACE_4, GetGridTexture(grid_pos4), <0.1, 0.1, 0>, GetGridOffset(grid_pos4), 0.0,
// PRIM_TEXTURE, FACE_5, GetGridTexture(grid_pos5), <0.25, 0.1, 0>, GetGridOffset(grid_pos5) - <0.075, 0, 0>, 0.0

]);
}

integer GetIndex(string char)
{
integer ret = llSubStringIndex(gCharIndex, char);

if(0 <= ret)
return ret;

// special char do nice trick :)
string escaped = llEscapeURL(char);

// remap ’
if (escaped == "%E2%80%99")
return 7;

// llSay(PUBLIC_CHANNEL, "Looking for " + escaped);
integer found = llListFindList(decode, [escaped]);

// not found
if(found < 0)
return FALSE;

// return correct index
return llStringLength(gCharIndex) + found;

}

RenderString(string str)
{
// Get the grid positions for each pair of characters.
vector GridPos1 = GetGridPos( GetIndex(llGetSubString(str, 0, 0)),
GetIndex(llGetSubString(str, 1, 1)) );
vector GridPos2 = GetGridPos( GetIndex(llGetSubString(str, 2, 2)),
GetIndex(llGetSubString(str, 3, 3)) );
vector GridPos3 = GetGridPos( GetIndex(llGetSubString(str, 4, 4)),
GetIndex(llGetSubString(str, 5, 5)) );
vector GridPos4 = GetGridPos( GetIndex(llGetSubString(str, 6, 6)),
GetIndex(llGetSubString(str, 7, 7)) );
vector GridPos5 = GetGridPos( GetIndex(llGetSubString(str, 8, 8)),
GetIndex(llGetSubString(str, 9, 9)) );

// Use these grid positions to display the correct textures/offsets.
ShowChars(GridPos1, GridPos2, GridPos3, GridPos4, GridPos5);
}
</lsl>

== Splitter python-fu script ==
You need to put this under the %USERPROFILE%\.gimp-2.6\plug-ins folder (in my case: \Documents and Settings\salahzar.SALAHZAR-PC\.gimp-2.6\plug-ins).

To avoid problems with indents, spaces and tabs create the file with explorer guides.py and right clich use the IDLE edit to past the following source.

Note: you need to restart GIMP to see it working.

When running it is very simple just tell it "512" to split every 512 points.
<python>
#!/usr/bin/env python

import math
from gimpfu import *

def python_guides(timg, tdrawable, interval=100):
timg.undo_group_start()
for x in range(0, timg.width, interval):
timg.add_vguide(x)

for y in range(0, timg.height, interval):
timg.add_hguide(y)

timg.undo_group_end()

gimp.displays_flush()

register(
"python_fu_guides",
"Guides: this will split the images in sections...",
"Guides: this will split the images in sections...",
"Salahzar Stenvaag",
" ",
"2008",
"<Image>/Filters/Guides...",
"RGB*, GRAY*",
[
(PF_INT, "interval", "Interval", 100)
],
[],
python_guides)

main()

</python>

If the guides.py script is correctly installed you will see the following:

[[Image:XyText-utf8-Guides.jpg]]

Options to choose:

[[Image:XyText-UTF8-Guides2.jpg]]

And the image with the lines in blue:

[[Image:XyText-UTF8-Guides3.jpg]]

== Mega-image maker python-fu script ==
You need to put this under the %USERPROFILE%\.gimp-2.6\plug-ins folder (in my case: \Documents and Settings\salahzar.SALAHZAR-PC\.gimp-2.6\plug-ins).

To avoid problems with indents, spaces and tabs create the file with explorer megaimages.py and right clich use the IDLE edit to past the following source.

If you need your characters you need to change the UTF-8 codings in "decode" var

<pre>
#! /usr/bin/env python
from gimpfu import *

# you can remove logging, I used it to be sure program was working since it can be a bit slow
# to generate all the combination
def python_log_init():
fileHandle = open( 'python.log', 'w')
fileHandle.close()

def python_log(s):
fileHandle = open ( 'python.log', 'a' )
fileHandle.write(str(s)+"\n")
fileHandle.close()

def python_xytext2(font,color,size,limit):
"""Print the arguments on standard output"""
python_log_init()
python_log("font: %s color: <%d,%d,%d> size: %d limit: %d" % ( font, color[0], color[1], color[2], size, limit ))
chars = " !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"

#

# cap cedille u: e/ a^ a: a/ a ring cedille e^ e:
decode= ["\xC3\x87", "\xC3\xBC", "\xC3\xA9", "\xC3\xA2", "\xC3\xA4", "\xC3\xA0", "\xC3\xA5", "\xC3\xA7", "\xC3\xAA", "\xC3\xAB" ]

# e\ i: i^ i\ A: A ring E/ ae AE marker >
decode+=["\xC3\xA8", "\xC3\xAF", "\xC3\xAE", "\xC3\xAC", "\xC3\x84", "\xC3\x85", "\xC3\x89", "\xC3\xA6", "\xC3\x86", "\xE2\x96\xB6" ]

# o: o/ u^ u\ y: O: U: cent pound yen
decode+=["\xC3\xB6", "\xC3\xB2", "\xC3\xBB", "\xC3\xB9", "\xC3\xBF", "\xC3\x96", "\xC3\x9C", "\xC2\xA2", "\xC2\xA3", "\xC2\xA5"]

# A^ a/ i/ o/ u/ n~ E: y/ inv ? O^
decode+=["\xC3\x82", "\xC3\xA1", "\xC3\xAD", "\xC3\xB3", "\xC3\xBA", "\xC3\xB1", "\xC3\x8B", "\xC3\xBD", "\xC2\xBF", "\xC3\x94" ]

# inv ! I\ I/ degree E^ I^ o^ U^
decode+=["\xC2\xA1", "\xC3\x8C", "\xC3\x8D", "\xC2\xB0", "\xC3\x8A", "\xC3\x8E", "\xC3\xB4", "\xC3\x9B" ]

# Y: euro german ss E\ A\ A/ U\ U/ O\ O/
decode+=["\xC3\x9D", "\xE2\x82\xAC", "\xC3\x9F", "\xC3\x88", "\xC3\x80", "\xC3\x81", "\xC3\x99", "\xC3\x9A", "\xC3\x92", "\xC3\x93" ]

# Sv sv zv Zv Y: I:
decode+=[ "\xC5\xA0", "\xC5\xA1", "\xC5\xBE", "\xC5\xBD", "\xC3\x9D", "\xC3\x8C" ]

width=5120
height=5120
img = gimp.Image(width, height, RGB)
layer = gimp.Layer(img, "my font", width, height, RGB_IMAGE, 100, NORMAL_MODE)
img.add_layer(layer, 0)
layer.add_alpha()
gimp.set_foreground(color)
pdb.gimp_selection_all(img)
pdb.gimp_edit_clear(layer)
pdb.gimp_selection_none(img)
size= 20 # 23 # 21.3 # 30

index=0
numtot=len(chars)+len(decode)
#numtot=50
if limit>0: numtot=limit
deltay=12.8 # 13.8215 # 12.8 # 18
deltax=25.6 # 27.6432 # 25.6 # 36
maxchars=len(chars)
for first in range(numtot):

if first<maxchars:
el1=chars[first]
else:
el1=decode[first-maxchars]

python_log(str(first)+"/"+str(numtot)+": "+el1)
for second in range(first+1):

# to save time removed function call
if second<maxchars:
el2=chars[second]
else:
el2=decode[second-maxchars]

y=second * deltay * 2 # horizontal distance
x=first*deltax # line distance
pdb.gimp_text_fontname(img,layer,y,x,el1,0,TRUE,size,PIXELS,font)
pdb.gimp_text_fontname(img,layer,y+deltay,x,el2,0,TRUE,size,PIXELS,font)

index+=1

# Now ready to display this image
img.merge_visible_layers(0)
gimp.Display(img)

register(
"xytext2", "", "", "", "", "",
"<Toolbox>/Xtns/_MegaImage", "",
[
(PF_FONT, "font", "Font to use", "Arial"),
(PF_COLOR,"color","Color to use", (255,255,255) ),
(PF_INT, "size", "Font size", 45 ),
(PF_INT, "limit", "limit font generation ", 0 ),

],
[],
python_xytext2
)

main()
</pre>

Here how the menu should appear:

[[Image:XyText-UTF8-Megaimagechoose.jpg]]

How to launch it: '''Note!! DON'T USE PROPORTIONAL CHARACTERS!!! BUT MONOSPACE 43 MIGHT BE BETTER'''
Also when checking use the limit font generation to 10: the computing process for all 200 characters is VEEERY LOOONG!!!! 0 means all the characters.

[[Image:XyText-UTF8-Megaimage2.jpg]]

How to zoom on the megaimage (Zoom 100%) and check produced characters:

[[Image:XyText-UTF8-Zoom11.jpg]]

As you see the default is producing BAD characters.. Proportional cannot be used since characters cannot be computed with xytext optimized algorithm.

[[Image:XyText-UTF8-Zoom2.jpg]]

== What if I want the full script? ==
Here you are:
<lsl>
// ZZText (5 Face, Multi Texture)
//
// Originally Written by Xylor Baysklef
//
// Modified by Thraxis Epsilon January 20, 2006
// Added Support for 5 Face Prim, based on modification
// of XyText v1.1.1 by Kermitt Quick for Single Texture.
//
// Modified by Salahzar Stenvaag for International and new textures
// produced with GIMP. See wiki page ZZText for further info
// Obtain ME (starting linking channel from Object name)
// thane can use all the other commands
// IDEAL for linked structures

// XyText Message Map.
integer DISPLAY_STRING = 0;
integer DISPLAY_EXTENDED = 100;
integer REMAP_INDICES = 200;
integer RESET_INDICES = 300;
integer SET_CELL_INFO = 400;
integer SET_THICKNESS = 600;
integer SET_COLOR = 700;

// This is an extended character escape sequence.
string ESCAPE_SEQUENCE = "\\e";

// This is used to get an index for the extended character.
string EXTENDED_INDEX = "123456789abcdef";

// Face numbers.
integer FACE_1 = 3;
integer FACE_2 = 7;
integer FACE_3 = 4;
integer FACE_4 = 6;
integer FACE_5 = 1;

// to handle special characters from CP850 page for european countries
list decode = [];

// Used to hide the text after a fade-out.
key TRANSPARENT = "701917a8-d614-471f-13dd-5f4644e36e3c";

// This is a list of textures for all 2-character combinations.
list CHARACTER_GRID = [
"96f4578b-879e-44ae-d223-427cc615f5a4", // my slice-0-0
"eab5360f-6653-593f-b679-69c68b0dd001", // 1-0
"367330be-717a-277d-5205-131cd6ded458", // 1-1
"32046675-6e7e-2425-ce77-69000b0b4d96", // 2-0
"40085901-bde6-2dd4-40cd-b6d48d242997", // 2-1
"205d318b-09b7-7ecc-922e-801c93a546c8", // 2-2
"841e7826-3645-d4f0-d48b-389586dd8e90", // 3-0
"e2db78c5-fb47-d767-4744-8cb6d84610d0", // 3-1
"15312c89-afd4-854c-9d9b-5b9e11844aed", // 3-2
"d180e771-0393-d09b-8cac-0af6d550ae4a", // 3-3
"c6c1d2c8-5dfd-b13a-7f1e-c3ede8126769", // 4-0
"bc100d0c-a445-947f-caa4-285d9cc8a9de", // 4-1
"0b31e862-75a4-9ed3-6331-e9e700a0fedb", // 4-2
"0eacc306-6bd5-ab31-de47-c686141a6733", // 4-3
"b68de1d9-4890-74a0-4d25-d4d5c83a0dba", // 4-4
"04b2bf9b-a8bb-0a39-1062-9b005229eba9", // 5-0
"be293f10-25ec-beb9-738b-fe1892b82aef", // 5-1
"5e9c8317-71f5-f073-76ab-7c412d3acb84", // 5-2
"030b441b-9022-2aba-f7a7-af6810c354b8", // 5-3
"9f455858-8ae6-3a9a-c2d4-bc5ee92430ac", // 5-4
"ee741143-f01e-f730-667e-66a3cd57d1cc", // 5-5
"710282bc-bd80-5a44-6987-0c4c11a4c294", // 6-0
"c9c410db-675a-1e98-4107-debd3c73a754", // 6-1
"486c2336-71c5-b962-266c-838a865c067c", // 6-2
"d4722155-0b6d-3673-0208-a727729bc117", // 6-3
"bc7af3cd-ee48-08df-fe8b-a6ca8a425733", // 6-4
"f23d7a73-00c3-1ffd-69a7-0cca031c939d", // 6-5
"aa95bfd1-ac80-f962-7acf-d6aeed9c7e81", // 6-6
"53fd52e3-0e8b-dcc8-42f8-332aef421bd2", // 7-0
"da3f6f09-3e3a-e156-8e2e-1040111a5635", // 7-1
"409a95c0-b685-2036-d0de-75e8ab654243", // 7-2
"14e05aca-3a61-b892-3632-dcde72324779", // 7-3
"546c0e4f-b678-895d-2035-0f39bb7f4979", // 7-4
"cf2fc337-109f-ba25-8ff5-786f7d6ceb5b", // 7-5
"9943204b-a4de-868a-3cdd-8785d1864ede", // 7-6
"765cfd9c-9703-b5ba-2c5d-f1c8bd44e0f4" // 7-7
];

integer ME;

// All displayable characters. Default to ASCII order.
string gCharIndex;

// This is the channel to listen on while acting
// as a cell in a larger display.
integer gCellChannel = -1;

// This is the starting character position in the cell channel message
// to render.
integer gCellCharPosition = 0;

// This is whether or not to use the fade in/out special effect.
integer gCellUseFading = FALSE;

// This is how long to display the text before fading out (if using
// fading special effect).
// Note: < 0 means don't fade out.
float gCellHoldDelay = 1.0;

ResetCharIndex()
{
gCharIndex = " !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`";
// \" <-- Fixes LSL syntax highlighting bug.
gCharIndex += "abcdefghijklmnopqrstuvwxyz{|}~";
// cap cedille u: e/ a^ a: a/ a ring cedille e^ e:
decode= ["%C3%87", "%C3%BC", "%C3%A9", "%C3%A2", "%C3%A4", "%C3%A0", "%C3%A5", "%C3%A7", "%C3%AA", "%C3%AB",

// e\ i: i^ i\ A: A ring E/ ae AE marker >
"%C3%A8", "%C3%AF", "%C3%AE", "%C3%AC", "%C3%84", "%C3%85", "%C3%89", "%C3%A6", "%C3%86", "%E2%96%B6" ,

// o: o/ u^ u\ y: O: U: cent pound yen
"%C3%B6", "%C3%B2", "%C3%BB", "%C3%B9", "%C3%BF", "%C3%96", "%C3%9C", "%C2%A2", "%C2%A3", "%C2%A5",

// A^ a/ i/ o/ u/ n~ E: y/ inv ? O^
"%C3%82", "%C3%A1", "%C3%AD", "%C3%B3", "%C3%BA", "%C3%B1", "%C3%8B", "%C3%BD", "%C2%BF", "%C3%94",

// inv ! I\ I/ degree E^ I^ o^ U^
"%C2%A1", "%C3%8C", "%C3%8D", "%C2%B0", "%C3%8A", "%C3%8E", "%C3%B4", "%C3%9B",

// Y: euro german ss E\ A\ A/ U\ U/ O\ O/
"%C3%9D", "%E2%82%AC", "%C3%9F", "%C3%88", "%C3%80", "%C3%81", "%C3%99", "%C3%9A", "%C3%92", "%C3%93",

// Sv sv zv Zv Y: I:
"%C5%A0", "%C5%A1", "%C5%BE", "%C5%BD", "%C3%9D", "%C3%8C" ];
}

vector GetGridPos(integer index1, integer index2)
{
// There are two ways to use the lookup table...
integer Col;
integer Row;
if (index1 >= index2)
{
// In this case, the row is the index of the first character:
Row = index1;
// And the col is the index of the second character (x2)
Col = index2 * 2;
}
// Index1 < Index2
else
{
// In this case, the row is the index of the second character:
Row = index2;
// And the col is the index of the first character, x2, offset by 1.
Col = index1 * 2 + 1;
}

return <Col, Row, 0>;
}

string GetGridTexture(vector grid_pos)
{
// Calculate the texture in the grid to use.
integer GridCol = llRound(grid_pos.x) / 40; // PK was 20
integer GridRow = llRound(grid_pos.y) / 20; // PK was 10

// Lookup the texture.
key Texture = llList2Key(CHARACTER_GRID, GridRow * (GridRow + 1) / 2 + GridCol);
return Texture;
}

vector GetGridOffset(vector grid_pos)
{
// Zoom in on the texture showing our character pair.
integer Col = llRound(grid_pos.x) % 40; // PK was 20
integer Row = llRound(grid_pos.y) % 20; // PK was 10

// Return the offset in the texture.
return <-0.45 + 0.025 * Col, 0.45 - 0.05 * Row, 0.0>; // PK was 0.05 and 0.1
}

ShowChars(vector grid_pos1, vector grid_pos2, vector grid_pos3, vector grid_pos4, vector grid_pos5)
{
// Set the primitive textures directly.

llSetLinkPrimitiveParamsFast(LINK_THIS, [
PRIM_TEXTURE, FACE_1, GetGridTexture(grid_pos1), <0.125, 0.05, 0>, GetGridOffset(grid_pos1) + <0.0375-0.025-0.002, 0.025, 0>, 0.0,
PRIM_TEXTURE, FACE_2, GetGridTexture(grid_pos2), <0.05, 0.05, 0>, GetGridOffset(grid_pos2)+<-0.025-0.002, 0.025,0>, 0.0,
PRIM_TEXTURE, FACE_3, GetGridTexture(grid_pos3), <-0.74, 0.05, 0>, GetGridOffset(grid_pos3)+ <-.34-0.002, 0.025, 0>, 0.0,
PRIM_TEXTURE, FACE_4, GetGridTexture(grid_pos4), <0.05, 0.05, 0>, GetGridOffset(grid_pos4)+<-0.025-0.002, 0.025,0>, 0.0,
PRIM_TEXTURE, FACE_5, GetGridTexture(grid_pos5), <0.125, 0.05, 0>, GetGridOffset(grid_pos5) + <0.0375-0.025-0.077-0.002, 0.025, 0>, 0.0
// PRIM_TEXTURE, FACE_1, GetGridTexture(grid_pos1), <0.25, 0.1, 0>, GetGridOffset(grid_pos1) + <0.075, 0, 0>, 0.0,
// PRIM_TEXTURE, FACE_2, GetGridTexture(grid_pos2), <0.1, 0.1, 0>, GetGridOffset(grid_pos2), 0.0,
// PRIM_TEXTURE, FACE_3, GetGridTexture(grid_pos3), <-1.48, 0.1, 0>, GetGridOffset(grid_pos3)+ <0.37, 0, 0>, 0.0,
// PRIM_TEXTURE, FACE_4, GetGridTexture(grid_pos4), <0.1, 0.1, 0>, GetGridOffset(grid_pos4), 0.0,
// PRIM_TEXTURE, FACE_5, GetGridTexture(grid_pos5), <0.25, 0.1, 0>, GetGridOffset(grid_pos5) - <0.075, 0, 0>, 0.0
]);
}

integer GetIndex(string char)
{
integer ret = llSubStringIndex(gCharIndex, char);

if(0 <= ret)
return ret;

// special char do nice trick :)
string escaped = llEscapeURL(char);

// remap ’
if(escaped == "%E2%80%99")
return 7;

//llSay(PUBLIC_CHANNEL, "Looking for " + escaped);
integer found = llListFindList(decode, [escaped]);

// not found
if(found < 0)
return FALSE;

// return correct index
return llStringLength(gCharIndex) + found;

}

RenderString(string str)
{
// Get the grid positions for each pair of characters.
vector GridPos1 = GetGridPos( GetIndex(llGetSubString(str, 0, 0)),
GetIndex(llGetSubString(str, 1, 1)) );
vector GridPos2 = GetGridPos( GetIndex(llGetSubString(str, 2, 2)),
GetIndex(llGetSubString(str, 3, 3)) );
vector GridPos3 = GetGridPos( GetIndex(llGetSubString(str, 4, 4)),
GetIndex(llGetSubString(str, 5, 5)) );
vector GridPos4 = GetGridPos( GetIndex(llGetSubString(str, 6, 6)),
GetIndex(llGetSubString(str, 7, 7)) );
vector GridPos5 = GetGridPos( GetIndex(llGetSubString(str, 8, 8)),
GetIndex(llGetSubString(str, 9, 9)) );

// Use these grid positions to display the correct textures/offsets.
ShowChars(GridPos1, GridPos2, GridPos3, GridPos4, GridPos5);
}

RenderWithEffects(string str)
{
// Get the grid positions for each pair of characters.
vector GridPos1 = GetGridPos( llSubStringIndex(gCharIndex, llGetSubString(str, 0, 0)),
llSubStringIndex(gCharIndex, llGetSubString(str, 1, 1)) );
vector GridPos2 = GetGridPos( llSubStringIndex(gCharIndex, llGetSubString(str, 2, 2)),
llSubStringIndex(gCharIndex, llGetSubString(str, 3, 3)) );
vector GridPos3 = GetGridPos( llSubStringIndex(gCharIndex, llGetSubString(str, 4, 4)),
llSubStringIndex(gCharIndex, llGetSubString(str, 5, 5)) );
vector GridPos4 = GetGridPos( llSubStringIndex(gCharIndex, llGetSubString(str, 6, 6)),
llSubStringIndex(gCharIndex, llGetSubString(str, 7, 7)) );
vector GridPos5 = GetGridPos( llSubStringIndex(gCharIndex, llGetSubString(str, 8, 8)),
llSubStringIndex(gCharIndex, llGetSubString(str, 9, 9)) );

// First set the alpha to the lowest possible.
llSetAlpha(0.05, ALL_SIDES);

// Use these grid positions to display the correct textures/offsets.
ShowChars(GridPos1, GridPos2, GridPos3, GridPos4, GridPos5);

float Alpha;
for (Alpha = 0.10; Alpha <= 1.0; Alpha += 0.05)
llSetAlpha(Alpha, ALL_SIDES);

// See if we want to fade out as well.
if (gCellHoldDelay < 0.0)
// No, bail out. (Just keep showing the string at full strength).
return;

// Hold the text for a while.
llSleep(gCellHoldDelay);

// Now fade out.
for (Alpha = 0.95; Alpha >= 0.05; Alpha -= 0.05)
llSetAlpha(Alpha, ALL_SIDES);

// Make the text transparent to fully hide it.
llSetTexture(TRANSPARENT, ALL_SIDES);
}

RenderExtended(string str)
{
// Look for escape sequences.
list Parsed = llParseString2List(str, [], [ESCAPE_SEQUENCE]);
integer ParsedLen = llGetListLength(Parsed);

// Create a list of index values to work with.
list Indices;
// We start with room for 6 indices.
integer IndicesLeft = 10;

integer i;
string Token;
integer Clipped;
integer LastWasEscapeSequence = FALSE;
// Work from left to right.
for (i = 0; i < ParsedLen && IndicesLeft > 0; i++)
{
Token = llList2String(Parsed, i);

// If this is an escape sequence, just set the flag and move on.
if (Token == ESCAPE_SEQUENCE)
{
LastWasEscapeSequence = TRUE;
}
// Token != ESCAPE_SEQUENCE
else
{
// Otherwise this is a normal token. Check its length.
Clipped = FALSE;
integer TokenLength = llStringLength(Token);

// Clip if necessary.
if (TokenLength > IndicesLeft)
{
Token = llGetSubString(Token, 0, IndicesLeft - 1);
TokenLength = llStringLength(Token);
IndicesLeft = 0;
Clipped = TRUE;
}
else
IndicesLeft -= TokenLength;

// Was the previous token an escape sequence?
if (LastWasEscapeSequence)
{
// Yes, the first character is an escape character, the rest are normal.

// This is the extended character.
Indices += [llSubStringIndex(EXTENDED_INDEX, llGetSubString(Token, 0, 0)) + 95];

// These are the normal characters.
integer j;
for (j = 1; j < TokenLength; j++)
Indices += [llSubStringIndex(gCharIndex, llGetSubString(Token, j, j))];
}
// Normal string.
else
{
// Just add the characters normally.
integer j;
for (j = 0; j < TokenLength; j++)
Indices += [llSubStringIndex(gCharIndex, llGetSubString(Token, j, j))];
}

// Unset this flag, since this was not an escape sequence.
LastWasEscapeSequence = FALSE;
}
}

// Use the indices to create grid positions.
vector GridPos1 = GetGridPos( llList2Integer(Indices, 0), llList2Integer(Indices, 1) );
vector GridPos2 = GetGridPos( llList2Integer(Indices, 2), llList2Integer(Indices, 3) );
vector GridPos3 = GetGridPos( llList2Integer(Indices, 4), llList2Integer(Indices, 5) );
vector GridPos4 = GetGridPos( llList2Integer(Indices, 6), llList2Integer(Indices, 7) );
vector GridPos5 = GetGridPos( llList2Integer(Indices, 8), llList2Integer(Indices, 9) );

// Use these grid positions to display the correct textures/offsets.
ShowChars(GridPos1, GridPos2, GridPos3, GridPos4, GridPos5);
}

integer ConvertIndex(integer index)
{
// This converts from an ASCII based index to our indexing scheme.
// ' ' or higher
if (index >= 32)
index -= 32;
// index < 32
else
{
// Quick bounds check.
if (index > 15)
index = 15;

index += 94; // extended characters
}

return index;
}

default
{
state_entry()
{
// Initialize the character index.
ResetCharIndex();
ME=(integer)llGetObjectName();
//llOwnerSay("Channel:"+(string)ME);
//llSay(0, "Free Memory: " + (string) llGetFreeMemory());
}

link_message(integer sender, integer channel, string data, key id)
{
if (channel == (ME+DISPLAY_STRING))
{
RenderString(data);
return;
}
if (channel == (ME+DISPLAY_EXTENDED))
{
RenderExtended(data);
return;
}
if (channel == gCellChannel)
{
// Extract the characters we are interested in, and use those to render.
string TextToRender = llGetSubString(data, gCellCharPosition, gCellCharPosition + 9);
if (gCellUseFading)
RenderWithEffects( TextToRender );
else // !gCellUseFading
RenderString( TextToRender );
return;
}
if (channel == (ME+REMAP_INDICES))
{
// Parse the message, splitting it up into index values.
list Parsed = llCSV2List(data);
integer i;
// Go through the list and swap each pair of indices.
for (i = 0; i < llGetListLength(Parsed); i += 2)
{
integer Index1 = ConvertIndex( llList2Integer(Parsed, i) );
integer Index2 = ConvertIndex( llList2Integer(Parsed, i + 1) );

// Swap these index values.
string Value1 = llGetSubString(gCharIndex, Index1, Index1);
string Value2 = llGetSubString(gCharIndex, Index2, Index2);

gCharIndex = llDeleteSubString(gCharIndex, Index1, Index1);
gCharIndex = llInsertString(gCharIndex, Index1, Value2);

gCharIndex = llDeleteSubString(gCharIndex, Index2, Index2);
gCharIndex = llInsertString(gCharIndex, Index2, Value1);
}
return;
}
if (channel == (ME+RESET_INDICES))
{
// Restore the character index back to default settings.
ResetCharIndex();
return;
}
if (channel == (ME+SET_CELL_INFO))
{
// Change the channel we listen to for cell commands, and the
// starting character position to extract from.
list Parsed = llCSV2List(data);
gCellChannel = (integer) llList2String(Parsed, 0);
gCellCharPosition = (integer) llList2String(Parsed, 1);
gCellUseFading = (integer) llList2String(Parsed, 2);
gCellHoldDelay = (float) llList2String(Parsed, 3);
return;
}
if (channel == (ME+SET_THICKNESS))
{
// Set our z scale to thickness, while staying fixed
// in position relative the prim below us.
vector Scale = llGetScale();
float Thickness = (float) data;
// Reposition only if this isn't the root prim.
integer ThisLink = llGetLinkNumber();
if (ThisLink != 0 || ThisLink != 1)
{
// This is not the root prim.
vector Up = llRot2Up(llGetLocalRot());
float DistanceToMove = Thickness / 2.0 - Scale.z / 2.0;
vector Pos = llGetLocalPos();
llSetPos(Pos + DistanceToMove * Up);
}
// Apply the new thickness.
Scale.z = Thickness;
llSetScale(Scale);
return;
}
if (channel == (ME+SET_COLOR))
{
vector newColor = (vector)data;
llSetColor(newColor, ALL_SIDES);
}
}
}
</lsl>

User:Toy Wylie/Phoenix/Preprocessor

2015-08-29T16:40:04Z

Phil Metalhead: Changing code indents to actual <source> tags

__NOTOC__

==Phoenix LSL Preprocessor==

===an overview by [[User:Toy Wylie|Toy Wylie]], rev. 0.8===

===1. Overview===

Developing scripts in LSL can be tedious, especially if you are creating scripts that use the same things over and over again, and you keep copying pieces of your older scripts to new creations. And even within one project, you often have to copy parts of your scripts into sub-scripts (example: link message numbers as identifiers for commands). Changing any of these numbers or updating and fixing bugs in older variants of the code might result in different versions of the same functions being used or in bugs found in older versions not being fixed in newer creations. The Phoenix LSL Preprocessor is a tool to help you circumvent a lot of these problems.

Adding and removing debugging statements is another thing with which the Preprocessor can be helpful. Usually you have debugging functions in the script to see if all is working fine, and you take them out before release. But this in itself creates new places for mistakes as well as the opportunity for some debugging output to remain in the script on release day because it was overlooked during final screening. Using the Phoenix LSL Preprocessor gives you a very simple way of making sure that no debug output is left in your final release.

===2. Setup===

To enable the Phoenix LSL Preprocessor, open your preferences panel (CTRL-P), click on "Phoenix", "Page 2", and then on "Inventory". Mark the checkbox "Enable LSL Preprocessor Filesystem Includes" and click on "Set". This will open a file requester, prompting you to point at a directory on your local computer. This is the place where you store all your LSL include files. Next, open any LSL script, click on "Advanced", and select "Enable Preprocessor". Then close the script.

===3. How it Works===

After setting up, you will see two tabs in your LSL editor: "Script" and "Preprocessed" ("Postprocessed" in older versions). The first is your active scripting window; the second shows the output of the Preprocessor, essentially the content that gets stored in the script. The postprocessed script contains the entire source code of what you have written in a comment block at the beginning, and the postprocessed output following this comment block. This ensures backwards compatibility with older versions of Phoenix and regular viewers that do not support preprocessing at all.

'''NOTE:''' Since the LSL/Mono compiler gets the script after preprocessing, the line numbers in error messages refer to the postprocessed script. So if you are getting compiler errors, be sure to look for the error in the "Postprocessed" tab rather than in your original script.

===4. A Short Example===

Create a file in your include folder with the name <tt>debug.lsl</tt>. Copy the following snippet into this file:

<source lang="lsl2">
#ifdef DEBUG
debug(string text)
{
llOwnerSay(text);
}
#else
#define debug(dummy)
#endif
</source>

Now create a new LSL script and copy the following code into the script editor:

<source lang="lsl2">
#define DEBUG
#include "debug.lsl"

default
{
state_entry()
{
debug("Debugging with the Phoenix LSL Preprocessor.");
}
}
</source>

Save the script. You will see the "Debugging with the Phoenix LSL Preprocessor" message in your chat console. Now change the first line of the LSL script to:

<source lang="lsl2">
#undef DEBUG
</source>

Save the script again. You will see that the debugging message is gone. This is a very handy way to enable and disable all debugging code in one single line. To understand what really happens, have a look at the "Postprocessed" tab. You can clearly see how the debug line will simply disappear, a lonely ";" the only trace of it having been there.

===5. The Optimizer===

Including files has one disadvantage though. You will get the complete contents of the file, if you need it or not. But the Phoenix LSL Preprocessor uses an optimizing technique, which only keeps the things you really used in your code and removes all global functions and variables you didn't reference in your script. This makes sure that your scripts don't get burdened with a lot of unused code. You can enable or disable this functionality in the script editor's "Advanced" menu.

===6. <tt>switch/case</tt> addition===

The Preprocessor also adds a set of new commands to the LSL editor which has been sorely missing until now: the <tt>switch/case</tt> construct known from many other languages. You can enable support for this construct in the script editor's "Advanced" menu. <tt>switch/case</tt> is a handy replacement for <tt>if(...) else if()</tt> chains. Additionally, switch/case supports "fallthrough" from one case to another, so you can chain up several cases with different conditions. A <tt>break</tt> statement is used to prevent fallthrough. The <tt>default</tt> case is used if none of the cases match the <tt>switch()</tt> condition.

Example:

<source lang="lsl2">
default
{
state_entry()
{
integer i;
switch(i)
{
case 1:
{
llOwnerSay("1");
// fallthrough to case 2
}
case 2:
{
llOwnerSay("1 or 2");
// no fallthrough
break;
}
case 3:
{
llOwnerSay("3");
// fallthrough to default
}
default:
{
llOwnerSay("3 or default");
}
}
}
}
</source>

===7. Lazy Lists addition===

Assigning values to list indexes is always a cumbersome thing to do in LSL (<tt>llListReplaceList()</tt> needed). Lazy Lists can help you a little by providing a way to just say:

<source lang="lsl2">
myList[index] = value;
</source>

Sadly it is not really possible to get list elements the same way because the return data can be of different types.

===8. Preprocessor Commands and Macros===

The Preprocessor understands the following commands:

#define
#undef
#ifdef
#ifndef
#if
#elif
#else
#endif
#warning
#error
#include

There are a few more, but these are not really useful within LSL.

Additionally, you can use the following macros in your scripts to help with debugging and giving you other useful information:

<tt>__FILE__</tt> - the full path to the script as it would appear in the include cache. The top script only uses its name. 
<tt>__LINE__</tt> - the line of the current script where it is expanded; this starts at line 0 
<tt>__SHORTFILE__</tt> - the name of the current script without full file path 
<tt>__AGENTID__</tt> - a string-encapsulated version of the agent's key who compiles the script 
<tt>__AGENTKEY__</tt> - same as above, legacy version 
<tt>__AGENTIDRAW__</tt> - a nonstring-encapsulated version of the agent's key who compiles the script 
<tt>__AGENTNAME__</tt> - a string-encapsulated version of the agent's full name who compiles the script 
<tt>__ASSETID__</tt> - a string-encapsulated version of the assetid of the current script; may return "NOT IN WORLD" or a nonstring-encapsulated null key in rare circumstances

Thanks to Zwagoth Klaar for this list.

===8.1 <tt>#define</tt>===

<tt>#define</tt> creates a case-sensitive macro which will be replaced while saving and compiling a script. This can be applied as simple constant numbers, strings, and even functions. What happens is a literal text replacement in the source code. Because of this, be careful with ";" inside your macros. These usually don't cause any harm; but within a one-line conditional, things can break in unexpected ways if it creates a ";;" in the end of a line, for example.

The following examples will give you an overview of what </tt>#define</tt> does. Have a look at the "Postprocessed" tab to see what the Preprocessor creates from the source.

Example 1:

<source lang="lsl2">
#define CHANNEL 12345
llOwnerSay((string) CHANNEL); // CHANNEL will be replaced with the literal 12345 stated in the #define above
</source>

<tt>#define</tt> can also take parameters to apply to the replacement code:

Example 2:

<source lang="lsl2">
#define OS(b,c) llOwnerSay(b+c)
OS("Test","123"); // will expand to: llOwnerSay("Test"+"123")
</source>

Example 3: Making strings out of parameters

<source lang="lsl2">
#define OS(a) llOwnerSay(#a)
OS(1234); // will expand to: llOwnerSay("1234");
</source>

Example 4: Using <tt>""##""</tt> to concatenate parameters

<source lang="lsl2">
#define OS(a,b) llOwnerSay((string) a##b)
OS(1234,5678); // will expand to: llOwnerSay((string) 12345678);
</source>

===8.2 <tt>#undef</tt>===

Removes a macro previously set up with <tt>#define</tt>. If the macro was not made in the first place, nothing happens. This is a useful way to enable or disable parts of the source code for debugging. See Section 4 above for an example on how to use it.

===8.3 <tt>#ifdef</tt> and <tt>#ifndef</tt>, <tt>#else</tt> and <tt>#endif</tt>===

This command is a part of conditional preprocessing in association with <tt>#else</tt> and <tt>#endif</tt>. <tt>#ifdef</tt> checks if a macro has been previously <tt>#define</tt>d. It doesn't matter if the macro has actually a value assigned to it. It just needs to be <tt>#define</tt>d. If it has, all of the code after <tt>#ifdef</tt> up to <tt>#endif</tt> or <tt>#else</tt> gets replaced into the postprocessed code. <tt>#ifndef</tt> does the exact opposite. If a macro does not exist, the code goes into the Preprocessor.

Example:

<source lang="lsl2">
#define OWNER_ONLY
...
#ifdef OWNER_ONLY
key var=llGetOwner();
#else
key var=llDetectedKey(0);
#endif
</source>

===8.4 <tt>#if</tt> and <tt>#elif</tt>===

These are also conditional preprocessing commands. They take a general condition and pass on the code to the Preprocessor if the condition evaluates to <tt>TRUE</tt>. They can also be used in conjunction with <tt>#else</tt>. <tt>#elif</tt> is the equivalent to <tt>else if</tt>.

Example:

#define DEBUGLEVEL 2

<source lang="lsl2">
#if DEBUGLEVEL==1
llOwnerSay("Point reached");
#elif DEBUGLEVEL==2
llOwnerSay("Lots of more data here");
#else
llOwnerSay("Unknown debug level: "+(string) DEBUGLEVEL);
#endif
</source>

===8.5 <tt>#warning</tt> and <tt>#error</tt>===

These two commands show a string in the compiler window to warn you about certain problems or to halt compilation immediately due to a fatal error. Right now, both <tt>#warning</tt> and <tt>#error</tt> cause the compiler to stop. It is unclear yet if <tt>#warning</tt> will allow the compiler to continue to completion in the future.

'''NOTE:''' If one of these commands is hit by the Preprocessor, the script is '''NOT''' saved!

Example 1:

<source lang="lsl2">
#warning This include file is obsolete!
</source>

Example 2:

<source lang="lsl2">
#error This include file does not work anymore. Please update.
</source>

===8.6 <tt>#include</tt>===

This is probably the most powerful feature of the Phoenix LSL Preprocessor. It includes whole source code files from your harddisk or from the same folder tree in your inventory into the script you are working on. A small example of this feature can be seen above in Section 4. <tt>#include</tt> takes a file name relative to the include path set up in your Preferences. You can also include files inside of subfolders. If you are compiling your script from your inventory, the Preprocessor will search the inventory path you are working in, descending into any subfolders, to find the referenced include file. Unused functions and global variable declarations are removed by the Optimizer.

Examples:

<source lang="lsl2">
#include "command_ids.lsl"
#include "general_functions.lsl"
#include "hud/layout.lsl"
</source>

'''NOTE:''' Be careful about including files from within <tt>#include</tt>s. You might <tt>#include</tt> a file twice, if you are not really keeping track, and this will lead to problems. This issue is usually addressed by using so-called "Include guards". You basically have a conditional compile that sets a <tt>#define</tt> macro and checks if it's already there. If it's not, <tt>#include</tt> the contents of the file. If it was set, ignore the contents.

Example:

<source lang="lsl2">
#ifndef SCRIPT_NAME_LSL
#define SCRIPT_NAME_LSL
your_script_starts_here()
{
}
#endif //SCRIPT_NAME_LSL
</source>

These <tt>#ifndef</tt>, <tt>#define</tt> and <tt>#endif</tt> commands make sure that the <tt>#include</tt> happens only once regardless of how often the file is actually referenced with <tt>#include</tt>.

===9. Known Issues===

* Including a file from your hard drive containing a <tt>#endif</tt> as last line (without linebreak) will not produce a warning about not having a line break but rather a statement error
* This can be fixed by adding a line break to the end of the file
* "Enable Text Compress" '''will break your script!''' (At least in its current form. It may be fixed, or removed, in the future.)

User:Toy Wylie/Phoenix/Preprocessor

2015-08-16T16:08:51Z

Phil Metalhead: Fixing the rest of the broken <lsl> tags

__NOTOC__

==Phoenix LSL Preprocessor==

===an overview by [[User:Toy Wylie|Toy Wylie]], rev. 0.8===

===1. Overview===

Developing scripts in LSL can be tedious, especially if you are creating scripts that use the same things over and over again, and you keep copying pieces of your older scripts to new creations. And even within one project, you often have to copy parts of your scripts into sub-scripts (example: link message numbers as identifiers for commands). Changing any of these numbers or updating and fixing bugs in older variants of the code might result in different versions of the same functions being used or in bugs found in older versions not being fixed in newer creations. The Phoenix LSL Preprocessor is a tool to help you circumvent a lot of these problems.

Adding and removing debugging statements is another thing with which the Preprocessor can be helpful. Usually you have debugging functions in the script to see if all is working fine, and you take them out before release. But this in itself creates new places for mistakes as well as the opportunity for some debugging output to remain in the script on release day because it was overlooked during final screening. Using the Phoenix LSL Preprocessor gives you a very simple way of making sure that no debug output is left in your final release.

===2. Setup===

To enable the Phoenix LSL Preprocessor, open your preferences panel (CTRL-P), click on "Phoenix", "Page 2", and then on "Inventory". Mark the checkbox "Enable LSL Preprocessor Filesystem Includes" and click on "Set". This will open a file requester, prompting you to point at a directory on your local computer. This is the place where you store all your LSL include files. Next, open any LSL script, click on "Advanced", and select "Enable Preprocessor". Then close the script.

===3. How it Works===

After setting up, you will see two tabs in your LSL editor: "Script" and "Preprocessed" ("Postprocessed" in older versions). The first is your active scripting window; the second shows the output of the Preprocessor, essentially the content that gets stored in the script. The postprocessed script contains the entire source code of what you have written in a comment block at the beginning, and the postprocessed output following this comment block. This ensures backwards compatibility with older versions of Phoenix and regular viewers that do not support preprocessing at all.

'''NOTE:''' Since the LSL/Mono compiler gets the script after preprocessing, the line numbers in error messages refer to the postprocessed script. So if you are getting compiler errors, be sure to look for the error in the "Postprocessed" tab rather than in your original script.

===4. A Short Example===

Create a file in your include folder with the name <tt>debug.lsl</tt>. Copy the following snippet into this file:

#ifdef DEBUG
debug(string text)
{
llOwnerSay(text);
}
#else
#define debug(dummy)
#endif

Now create a new LSL script and copy the following code into the script editor:

#define DEBUG
#include "debug.lsl"

default
{
state_entry()
{
debug("Debugging with the Phoenix LSL Preprocessor.");
}
}

Save the script. You will see the "Debugging with the Phoenix LSL Preprocessor" message in your chat console. Now change the first line of the LSL script to:

#undef DEBUG

Save the script again. You will see that the debugging message is gone. This is a very handy way to enable and disable all debugging code in one single line. To understand what really happens, have a look at the "Postprocessed" tab. You can clearly see how the debug line will simply disappear, a lonely ";" the only trace of it having been there.

===5. The Optimizer===

Including files has one disadvantage though. You will get the complete contents of the file, if you need it or not. But the Phoenix LSL Preprocessor uses an optimizing technique, which only keeps the things you really used in your code and removes all global functions and variables you didn't reference in your script. This makes sure that your scripts don't get burdened with a lot of unused code. You can enable or disable this functionality in the script editor's "Advanced" menu.

===6. <tt>switch/case</tt> addition===

The Preprocessor also adds a set of new commands to the LSL editor which has been sorely missing until now: the <tt>switch/case</tt> construct known from many other languages. You can enable support for this construct in the script editor's "Advanced" menu. <tt>switch/case</tt> is a handy replacement for <tt>if(...) else if()</tt> chains. Additionally, switch/case supports "fallthrough" from one case to another, so you can chain up several cases with different conditions. A <tt>break</tt> statement is used to prevent fallthrough. The <tt>default</tt> case is used if none of the cases match the <tt>switch()</tt> condition.

Example:

default
{
state_entry()
{
integer i;
switch(i)
{
case 1:
{
llOwnerSay("1");
// fallthrough to case 2
}
case 2:
{
llOwnerSay("1 or 2");
// no fallthrough
break;
}
case 3:
{
llOwnerSay("3");
// fallthrough to default
}
default:
{
llOwnerSay("3 or default");
}
}
}
}

===7. Lazy Lists addition===

Assigning values to list indexes is always a cumbersome thing to do in LSL (<tt>llListReplaceList()</tt> needed). Lazy Lists can help you a little by providing a way to just say:

myList[index]=value;

Sadly it is not really possible to get list elements the same way because the return data can be of different types.

===8. Preprocessor Commands and Macros===

The Preprocessor understands the following commands:

#define
#undef
#ifdef
#ifndef
#if
#elif
#else
#endif
#warning
#error
#include

There are a few more, but these are not really useful within LSL.

Additionally, you can use the following macros in your scripts to help with debugging and giving you other useful information:

<tt>__FILE__</tt> - the full path to the script as it would appear in the include cache. The top script only uses its name. 
<tt>__LINE__</tt> - the line of the current script where it is expanded; this starts at line 0 
<tt>__SHORTFILE__</tt> - the name of the current script without full file path 
<tt>__AGENTID__</tt> - a string-encapsulated version of the agent's key who compiles the script 
<tt>__AGENTKEY__</tt> - same as above, legacy version 
<tt>__AGENTIDRAW__</tt> - a nonstring-encapsulated version of the agent's key who compiles the script 
<tt>__AGENTNAME__</tt> - a string-encapsulated version of the agent's full name who compiles the script 
<tt>__ASSETID__</tt> - a string-encapsulated version of the assetid of the current script; may return "NOT IN WORLD" or a nonstring-encapsulated null key in rare circumstances

Thanks to Zwagoth Klaar for this list.

===8.1 <tt>#define</tt>===

<tt>#define</tt> creates a case-sensitive macro which will be replaced while saving and compiling a script. This can be applied as simple constant numbers, strings, and even functions. What happens is a literal text replacement in the source code. Because of this, be careful with ";" inside your macros. These usually don't cause any harm; but within a one-line conditional, things can break in unexpected ways if it creates a ";;" in the end of a line, for example.

The following examples will give you an overview of what </tt>#define</tt> does. Have a look at the "Postprocessed" tab to see what the Preprocessor creates from the source.

Example 1:

#define CHANNEL 12345
llOwnerSay((string) CHANNEL); // CHANNEL will be replaced with the literal 12345 stated in the #define above

<tt>#define</tt> can also take parameters to apply to the replacement code:

Example 2:

#define OS(b,c) llOwnerSay(b+c)
OS("Test","123"); // will expand to: llOwnerSay("Test"+"123")

Example 3: Making strings out of parameters

#define OS(a) llOwnerSay(#a)
OS(1234); // will expand to: llOwnerSay("1234");

Example 4: Using <tt>""##""</tt> to concatenate parameters

#define OS(a,b) llOwnerSay((string) a##b)
OS(1234,5678); // will expand to: llOwnerSay((string) 12345678);

===8.2 <tt>#undef</tt>===

Removes a macro previously set up with <tt>#define</tt>. If the macro was not made in the first place, nothing happens. This is a useful way to enable or disable parts of the source code for debugging. See Section 4 above for an example on how to use it.

===8.3 <tt>#ifdef</tt> and <tt>#ifndef</tt>, <tt>#else</tt> and <tt>#endif</tt>===

This command is a part of conditional preprocessing in association with <tt>#else</tt> and <tt>#endif</tt>. <tt>#ifdef</tt> checks if a macro has been previously <tt>#define</tt>d. It doesn't matter if the macro has actually a value assigned to it. It just needs to be <tt>#define</tt>d. If it has, all of the code after <tt>#ifdef</tt> up to <tt>#endif</tt> or <tt>#else</tt> gets replaced into the postprocessed code. <tt>#ifndef</tt> does the exact opposite. If a macro does not exist, the code goes into the Preprocessor.

Example:

#define OWNER_ONLY
...
#ifdef OWNER_ONLY
key var=llGetOwner();
#else
key var=llDetectedKey(0);
#endif

===8.4 <tt>#if</tt> and <tt>#elif</tt>===

These are also conditional preprocessing commands. They take a general condition and pass on the code to the Preprocessor if the condition evaluates to <tt>TRUE</tt>. They can also be used in conjunction with <tt>#else</tt>. <tt>#elif</tt> is the equivalent to <tt>else if</tt>.

Example:

#define DEBUGLEVEL 2

#if DEBUGLEVEL==1
llOwnerSay("Point reached");
#elif DEBUGLEVEL==2
llOwnerSay("Lots of more data here");
#else
llOwnerSay("Unknown debug level: "+(string) DEBUGLEVEL);
#endif

===8.5 <tt>#warning</tt> and <tt>#error</tt>===

These two commands show a string in the compiler window to warn you about certain problems or to halt compilation immediately due to a fatal error. Right now, both <tt>#warning</tt> and <tt>#error</tt> cause the compiler to stop. It is unclear yet if <tt>#warning</tt> will allow the compiler to continue to completion in the future.

'''NOTE:''' If one of these commands is hit by the Preprocessor, the script is '''NOT''' saved!

Example 1:

#warning This include file is obsolete!

Example 2:

#error This include file does not work anymore. Please update.

===8.6 <tt>#include</tt>===

This is probably the most powerful feature of the Phoenix LSL Preprocessor. It includes whole source code files from your harddisk or from the same folder tree in your inventory into the script you are working on. A small example of this feature can be seen above in Section 4. <tt>#include</tt> takes a file name relative to the include path set up in your Preferences. You can also include files inside of subfolders. If you are compiling your script from your inventory, the Preprocessor will search the inventory path you are working in, descending into any subfolders, to find the referenced include file. Unused functions and global variable declarations are removed by the Optimizer.

Examples:

#include "command_ids.lsl"
#include "general_functions.lsl"
#include "hud/layout.lsl"

'''NOTE:''' Be careful about including files from within <tt>#include</tt>s. You might <tt>#include</tt> a file twice, if you are not really keeping track, and this will lead to problems. This issue is usually addressed by using so-called "Include guards". You basically have a conditional compile that sets a <tt>#define</tt> macro and checks if it's already there. If it's not, <tt>#include</tt> the contents of the file. If it was set, ignore the contents.

Example:

#ifndef SCRIPT_NAME_LSL
#define SCRIPT_NAME_LSL
your_script_starts_here()
{
}
#endif //SCRIPT_NAME_LSL

These <tt>#ifndef</tt>, <tt>#define</tt> and <tt>#endif</tt> commands make sure that the <tt>#include</tt> happens only once regardless of how often the file is actually referenced with <tt>#include</tt>.

===9. Known Issues===

* Including a file from your hard drive containing a <tt>#endif</tt> as last line (without linebreak) will not produce a warning about not having a line break but rather a statement error
* This can be fixed by adding a line break to the end of the file
* "Enable Text Compress" '''will break your script!''' (At least in its current form. It may be fixed, or removed, in the future.)

User:Toy Wylie/Phoenix/Preprocessor

2015-08-16T15:57:20Z

Phil Metalhead: Fixing broken <lsl> tags :(

__NOTOC__

==Phoenix LSL Preprocessor==

===an overview by [[User:Toy Wylie|Toy Wylie]], rev. 0.8===

===1. Overview===

Developing scripts in LSL can be tedious, especially if you are creating scripts that use the same things over and over again, and you keep copying pieces of your older scripts to new creations. And even within one project, you often have to copy parts of your scripts into sub-scripts (example: link message numbers as identifiers for commands). Changing any of these numbers or updating and fixing bugs in older variants of the code might result in different versions of the same functions being used or in bugs found in older versions not being fixed in newer creations. The Phoenix LSL Preprocessor is a tool to help you circumvent a lot of these problems.

Adding and removing debugging statements is another thing with which the Preprocessor can be helpful. Usually you have debugging functions in the script to see if all is working fine, and you take them out before release. But this in itself creates new places for mistakes as well as the opportunity for some debugging output to remain in the script on release day because it was overlooked during final screening. Using the Phoenix LSL Preprocessor gives you a very simple way of making sure that no debug output is left in your final release.

===2. Setup===

To enable the Phoenix LSL Preprocessor, open your preferences panel (CTRL-P), click on "Phoenix", "Page 2", and then on "Inventory". Mark the checkbox "Enable LSL Preprocessor Filesystem Includes" and click on "Set". This will open a file requester, prompting you to point at a directory on your local computer. This is the place where you store all your LSL include files. Next, open any LSL script, click on "Advanced", and select "Enable Preprocessor". Then close the script.

===3. How it Works===

After setting up, you will see two tabs in your LSL editor: "Script" and "Preprocessed" ("Postprocessed" in older versions). The first is your active scripting window; the second shows the output of the Preprocessor, essentially the content that gets stored in the script. The postprocessed script contains the entire source code of what you have written in a comment block at the beginning, and the postprocessed output following this comment block. This ensures backwards compatibility with older versions of Phoenix and regular viewers that do not support preprocessing at all.

'''NOTE:''' Since the LSL/Mono compiler gets the script after preprocessing, the line numbers in error messages refer to the postprocessed script. So if you are getting compiler errors, be sure to look for the error in the "Postprocessed" tab rather than in your original script.

===4. A Short Example===

Create a file in your include folder with the name <tt>debug.lsl</tt>. Copy the following snippet into this file:

#ifdef DEBUG
debug(string text)
{
llOwnerSay(text);
}
#else
#define debug(dummy)
#endif

Now create a new LSL script and copy the following code into the script editor:

#define DEBUG
#include "debug.lsl"

default
{
state_entry()
{
debug("Debugging with the Phoenix LSL Preprocessor.");
}
}

Save the script. You will see the "Debugging with the Phoenix LSL Preprocessor" message in your chat console. Now change the first line of the LSL script to:

#undef DEBUG

Save the script again. You will see that the debugging message is gone. This is a very handy way to enable and disable all debugging code in one single line. To understand what really happens, have a look at the "Postprocessed" tab. You can clearly see how the debug line will simply disappear, a lonely ";" the only trace of it having been there.

===5. The Optimizer===

Including files has one disadvantage though. You will get the complete contents of the file, if you need it or not. But the Phoenix LSL Preprocessor uses an optimizing technique, which only keeps the things you really used in your code and removes all global functions and variables you didn't reference in your script. This makes sure that your scripts don't get burdened with a lot of unused code. You can enable or disable this functionality in the script editor's "Advanced" menu.

===6. <tt>switch/case</tt> addition===

The Preprocessor also adds a set of new commands to the LSL editor which has been sorely missing until now: the <tt>switch/case</tt> construct known from many other languages. You can enable support for this construct in the script editor's "Advanced" menu. <tt>switch/case</tt> is a handy replacement for <tt>if(...) else if()</tt> chains. Additionally, switch/case supports "fallthrough" from one case to another, so you can chain up several cases with different conditions. A <tt>break</tt> statement is used to prevent fallthrough. The <tt>default</tt> case is used if none of the cases match the <tt>switch()</tt> condition.

Example:

<lsl>default
{
state_entry()
{
integer i;
switch(i)
{
case 1:
{
llOwnerSay("1");
// fallthrough to case 2
}
case 2:
{
llOwnerSay("1 or 2");
// no fallthrough
break;
}
case 3:
{
llOwnerSay("3");
// fallthrough to default
}
default:
{
llOwnerSay("3 or default");
}
}
}
}</lsl>

===7. Lazy Lists addition===

Assigning values to list indexes is always a cumbersome thing to do in LSL (<tt>llListReplaceList()</tt> needed). Lazy Lists can help you a little by providing a way to just say:

<lsl>myList[index]=value;</lsl>

Sadly it is not really possible to get list elements the same way because the return data can be of different types.

===8. Preprocessor Commands and Macros===

The Preprocessor understands the following commands:

<lsl>#define
#undef
#ifdef
#ifndef
#if
#elif
#else
#endif
#warning
#error
#include</lsl>

There are a few more, but these are not really useful within LSL.

Additionally, you can use the following macros in your scripts to help with debugging and giving you other useful information:

<tt>__FILE__</tt> - the full path to the script as it would appear in the include cache. The top script only uses its name. 
<tt>__LINE__</tt> - the line of the current script where it is expanded; this starts at line 0 
<tt>__SHORTFILE__</tt> - the name of the current script without full file path 
<tt>__AGENTID__</tt> - a string-encapsulated version of the agent's key who compiles the script 
<tt>__AGENTKEY__</tt> - same as above, legacy version 
<tt>__AGENTIDRAW__</tt> - a nonstring-encapsulated version of the agent's key who compiles the script 
<tt>__AGENTNAME__</tt> - a string-encapsulated version of the agent's full name who compiles the script 
<tt>__ASSETID__</tt> - a string-encapsulated version of the assetid of the current script; may return "NOT IN WORLD" or a nonstring-encapsulated null key in rare circumstances

Thanks to Zwagoth Klaar for this list.

===8.1 <tt>#define</tt>===

<tt>#define</tt> creates a case-sensitive macro which will be replaced while saving and compiling a script. This can be applied as simple constant numbers, strings, and even functions. What happens is a literal text replacement in the source code. Because of this, be careful with ";" inside your macros. These usually don't cause any harm; but within a one-line conditional, things can break in unexpected ways if it creates a ";;" in the end of a line, for example.

The following examples will give you an overview of what </tt>#define</tt> does. Have a look at the "Postprocessed" tab to see what the Preprocessor creates from the source.

Example 1:

<lsl>#define CHANNEL 12345
llOwnerSay((string) CHANNEL); // CHANNEL will be replaced with the literal 12345 stated in the #define above</lsl>

<tt>#define</tt> can also take parameters to apply to the replacement code:

Example 2:

<lsl>#define OS(b,c) llOwnerSay(b+c)
OS("Test","123"); // will expand to: llOwnerSay("Test"+"123")</lsl>

Example 3: Making strings out of parameters

<lsl>#define OS(a) llOwnerSay(#a)
OS(1234); // will expand to: llOwnerSay("1234");</lsl>

Example 4: Using <tt>""##""</tt> to concatenate parameters

<lsl>#define OS(a,b) llOwnerSay((string) a##b)
OS(1234,5678); // will expand to: llOwnerSay((string) 12345678);</lsl>

===8.2 <tt>#undef</tt>===

Removes a macro previously set up with <tt>#define</tt>. If the macro was not made in the first place, nothing happens. This is a useful way to enable or disable parts of the source code for debugging. See Section 4 above for an example on how to use it.

===8.3 <tt>#ifdef</tt> and <tt>#ifndef</tt>, <tt>#else</tt> and <tt>#endif</tt>===

This command is a part of conditional preprocessing in association with <tt>#else</tt> and <tt>#endif</tt>. <tt>#ifdef</tt> checks if a macro has been previously <tt>#define</tt>d. It doesn't matter if the macro has actually a value assigned to it. It just needs to be <tt>#define</tt>d. If it has, all of the code after <tt>#ifdef</tt> up to <tt>#endif</tt> or <tt>#else</tt> gets replaced into the postprocessed code. <tt>#ifndef</tt> does the exact opposite. If a macro does not exist, the code goes into the Preprocessor.

Example:

<lsl>#define OWNER_ONLY
...
#ifdef OWNER_ONLY
key var=llGetOwner();
#else
key var=llDetectedKey(0);
#endif</lsl>

===8.4 <tt>#if</tt> and <tt>#elif</tt>===

These are also conditional preprocessing commands. They take a general condition and pass on the code to the Preprocessor if the condition evaluates to <tt>TRUE</tt>. They can also be used in conjunction with <tt>#else</tt>. <tt>#elif</tt> is the equivalent to <tt>else if</tt>.

Example:

<lsl>#define DEBUGLEVEL 2

#if DEBUGLEVEL==1
llOwnerSay("Point reached");
#elif DEBUGLEVEL==2
llOwnerSay("Lots of more data here");
#else
llOwnerSay("Unknown debug level: "+(string) DEBUGLEVEL);
#endif</lsl>

===8.5 <tt>#warning</tt> and <tt>#error</tt>===

These two commands show a string in the compiler window to warn you about certain problems or to halt compilation immediately due to a fatal error. Right now, both <tt>#warning</tt> and <tt>#error</tt> cause the compiler to stop. It is unclear yet if <tt>#warning</tt> will allow the compiler to continue to completion in the future.

'''NOTE:''' If one of these commands is hit by the Preprocessor, the script is '''NOT''' saved!

Example 1:

<lsl>#warning This include file is obsolete!</lsl>

Example 2:

<lsl>#error This include file does not work anymore. Please update.</lsl>

===8.6 <tt>#include</tt>===

This is probably the most powerful feature of the Phoenix LSL Preprocessor. It includes whole source code files from your harddisk or from the same folder tree in your inventory into the script you are working on. A small example of this feature can be seen above in Section 4. <tt>#include</tt> takes a file name relative to the include path set up in your Preferences. You can also include files inside of subfolders. If you are compiling your script from your inventory, the Preprocessor will search the inventory path you are working in, descending into any subfolders, to find the referenced include file. Unused functions and global variable declarations are removed by the Optimizer.

Examples:

<lsl>#include "command_ids.lsl"
#include "general_functions.lsl"
#include "hud/layout.lsl"</lsl>

'''NOTE:''' Be careful about including files from within <tt>#include</tt>s. You might <tt>#include</tt> a file twice, if you are not really keeping track, and this will lead to problems. This issue is usually addressed by using so-called "Include guards". You basically have a conditional compile that sets a <tt>#define</tt> macro and checks if it's already there. If it's not, <tt>#include</tt> the contents of the file. If it was set, ignore the contents.

Example:

<lsl>#ifndef SCRIPT_NAME_LSL
#define SCRIPT_NAME_LSL
your_script_starts_here()
{
}
#endif //SCRIPT_NAME_LSL</lsl>

These <tt>#ifndef</tt>, <tt>#define</tt> and <tt>#endif</tt> commands make sure that the <tt>#include</tt> happens only once regardless of how often the file is actually referenced with <tt>#include</tt>.

===9. Known Issues===

* Including a file from your hard drive containing a <tt>#endif</tt> as last line (without linebreak) will not produce a warning about not having a line break but rather a statement error
* This can be fixed by adding a line break to the end of the file
* "Enable Text Compress" '''will break your script!''' (At least in its current form. It may be fixed, or removed, in the future.)

String2Hex

2015-04-06T02:00:33Z

Phil Metalhead: updated <lsl> tags to <source> tags

==Full Unicode Support==

Uses UTF-8 encoding of characters. If you can get the character into a string in LSL, this will encode that character in hex.

For performance reasons you should really just get used to using Base64. Since LSL has no hex functions, implementing them comes at a great performance cost.

<source lang="lsl2">
string String2Hex(string str){
string b64 = (string)llParseString2List(llStringToBase64(str), ["="], []);
integer length = ((llStringLength(b64) * 3) >> 1) & -2;
b64 += "AAAAAAA"; // we will trim these off in the end, this works around SVC-104.
integer count = -3;
integer position = -4;
string out;
while ((count += 6) < length) {
integer I = llBase64ToInteger(llGetSubString(b64, position += 4, position + 7)) | 1;//This is a bottle neck
string T = "";
do {
integer A = (I >> 2) & 0x3C000000; //28 -> 26
integer B = (I >> 4) & 0x00F00000; //24 -> 20
integer C = (I >> 6) & 0x0003C000; //20 -> 14
T += llGetSubString( //ABC
llIntegerToBase64(
A + B + C + 0xD34D0000
- (0xF8000000 * (A / 0x28000000)) //lowercase=0x90000000, uppercase=0xF8000000
- (0x03E00000 * (B / 0x00A00000)) //lowercase=0x02400000, uppercase=0x03E00000
- (0x000F8000 * (C / 0x00028000)) //lowercase=0x00090000, uppercase=0x000F8000
), 0, 3);
} while (((I = (I << 12)) & 0x1EE7);
out += T;//This is a bottle neck
}
return llGetSubString(out, 0, length - 1);
}

string Hex2String(string hex) {
integer length = (llStringLength(hex) + 1) & -2;
while(length)
hex = llInsertString(hex, length -= 2, "%");
return llUnescapeURL(hex); //lol
}
</source>

==Limited ASCII-7 Support==

These functions only works for ASCII-7 non-control characters.

<source lang="lsl2">
string c_chr=" !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~";

// http://wiki.secondlife.com/wiki/Int2Hex
string int2hex(integer x){
string toret;
do{
toret=llGetSubString("0123456789ABCDEF",x&0x0000000F,x&0x0000000F)+toret;
}while (x=x>>4&0x0FFFFFFF);
return toret;
}

string str2hex(string str){
string ret="";
integer strlen=llStringLength(str);
integer i=0;
for(;i<strlen;++i){
ret+=int2hex(32+llSubStringIndex(c_chr,llGetSubString(str,i,i)));
}
return ret;
}

string hex2str(string str){
string ret="";
integer strlen=llStringLength(str);
integer i=0;integer index;
for(;i<strlen;i+=2){
index=((integer)("0x"+llGetSubString(str,i,i+1)))-32;
ret+=llGetSubString(c_chr,index,index);
}
return ret;
}

default{
state_entry(){
llOwnerSay(str2hex("test ~"));
llOwnerSay(hex2str("74657374207E"));
}
}
</source>

NumPad

2015-04-05T05:56:41Z

Phil Metalhead: Un-broke the code formatting

{{LSL Header}}
{{RightToc}}

Scripting tools to allow display of text on a prim: [[XyText 1.5]] , [[XyzzyText]], [[XyyyyzText]], [[XyText-UTF8]], [[XyzzyText-UTF8]], [[ZZText]], [[VariText]]

'''NumPad''' is a variant of the text on a prim but with some changes

* 1 texture vs 5 textures needed for XyText 1.5 'to render numbers'
* Numbers and spaces only.
* About 73 lines of code.

=Copyright & Licensing=

* Madpeter Zond hereby releases his contributions to this under the MIT license. [Starting texture and Starting code]



=NumPad 10digits=

Quickstart:
<pre>
* Take a copy of the 10 char prim setup from [[XyText 1.5]] and setup a prim
* After running the code create a new script and copy the NumPad code to it.
</pre>

Usage:
<pre>
* Set render_to_prim_number to the number of the prim you wish to render to,
* if you dont know the number you can put the script inside of the prim you want
* and not change this.
</pre>

==Main Script==
<source lang="lsl2">
////////////////////////////////////////////////////
// NumPad
// ----------------
// Version: 1.0
// By: Madpeter Zond
// About: A 1 texture 10 digit number display
// great for a score output.
////////////////////////////////////////////////////

string texture = "31f72af5-dee3-72f5-3981-bde21bf85e9c";
integer render_to_prim_number = LINK_THIS;
vector render_color = <1,1,1>;
float glow_amount = 0.00;

// please dont change this unless you want to break something ^_^
list faces = [3,7,4,6,1];
list grid_offset_starts = [<-0.38941,-0.54747,0> ,<-0.44939,-0.54750,0>, <0.01800,0.45256,0>,<-0.44939,-0.54750,0>,<-0.50941,-0.54747,0>];
list repeats_corrections = [<0.1,0,0>,<0,0,0>,<-1.35,0,0>,<0,0,0>,<0.1,0,0>];
vector repeats_config = <0.1,0.083333,0>;
float fix(float input) // render blocking fix [haxy]
{
if(input > 1.0) input -= 1.0;
else if(input < -1.0) input += 1.0;
return input;
}
render(string output)
{
while(llStringLength(output) <= 10) { output = ""+output+" "; }
list renderrules = [];
integer loop = 0;
while(loop < 5)
{
string part = llGetSubString(output,(2*loop),(2*loop)+1);
if(part == " ")
{
// empty
renderrules = renderrules + [PRIM_COLOR,llList2Integer(faces,loop),<1,1,1>,0,PRIM_GLOW,llList2Integer(faces,loop),0];
}
else
{
integer Y_offset = (integer)llGetSubString(part,0,0);
integer X_offset = (integer)llGetSubString(part,1,1);
if(llGetSubString(part,0,0) == " ") Y_offset = 10; // left side empty
else if(llGetSubString(part,1,1) == " ")
{
Y_offset = 11; // right side empty
X_offset = (integer)llGetSubString(part,0,0);
}
vector start = llList2Vector(grid_offset_starts,loop);
start = <fix(start.x + (0.1 * X_offset)),fix(start.y + (-0.083333333 * Y_offset)),0>;
renderrules = renderrules + [PRIM_TEXTURE,llList2Integer(faces,loop),texture,repeats_config+llList2Vector(repeats_corrections,loop),start,0,PRIM_COLOR,llList2Integer(faces,loop),render_color,1,PRIM_GLOW,llList2Integer(faces,loop),glow_amount];
}
loop++;
}
llSetLinkPrimitiveParamsFast(render_to_prim_number,renderrules);
}
default
{
state_entry()
{
render("1234567890");
}
}
</source>

==Texture layout==
 the texture is setup in a 10x12 format as follows.
<pre>
00 01 02 03 04 05 06 07 08 09
10 11 12 13 14 15 16 17 18 19
20 21 22 23 24 25 26 27 28 29
30 31 32 33 34 35 36 37 38 39
40 41 42 43 44 45 46 47 48 49
50 51 52 53 54 55 56 57 58 59
60 61 62 63 64 65 66 67 68 69
70 71 72 73 74 75 76 77 78 79
80 81 82 83 84 85 86 87 88 89
90 91 92 93 94 95 96 97 98 99
_0 _1 _2 _3 _4 _5 _6 _7 _8 _9
0_ 1_ 2_ 3_ 4_ 5_ 6_ 7_ 8_ 9_
</pre>

==Improvements==

there are some improvements that could be made 
 
1: Change the texture format to 11x11 to improve the quality of the numbers. 
2: Change the while loop to a for loop if that saves memory. 
3: Change the way it builds rules if a way is found that saves script memory.