CompareMyrScriptVersion(string version)

Is MyrScript =, < or > version x.y.z?

As Application.MyrScriptVersion is a string, comparison may fail in the future, "10.1.1" is greater than "9.9.9" but string comparison will stay it's lower (because "1" < "9").

Return

string: "<", ">" or "=" if Application.MyrScriptVersion is lower, greater or equal to version.

CompareVersions(string a, string b)

Compare two version numbers in x.y.z string format.

Return

string: "<", ">" or "=" if a is lower, greater or equal to b.

Example

CompareVersions("9.9.7", "9.9.6") --> ">"

round(number num, int numberOfDecimals)

Round a number.

Return

number: the rounded number, i.e. floor(number + 0.5) for an integer (no decimals)

NumberOfDecimals(number n)

Get the number of decimals of a number

Return

number: number

bound(number n, number mini, number maxi)

Ensure number n is within bounds [mini:maxi].

bound(n, mini, maxi) is a syntaxic sugar for max(min(n, maxi), mini)

Return

number: Bounded n.

dpi72_to_cm(number n)

Convert a 72 DPI pixel value into centimeters.

Return

number: number

cm_to_dpi72(number n)

Convert a centimeter value into 72 DPI pixels.

Return

number: number

SMPitchToString(int pitch, int preferredAccidental, int compatible, string preferredNote)

Extension and bugfix for builtin PitchToString function.

• Allow pitches out of 0..127 bounds, but keep in mind that HA can't handle them!
• PitchToString(11) gives 11, SMPitchToString(11) returns B-1

Returns

string: Anglo-saxon note name followed by octave, e.g. "Ab5".

int: Accidental for the note, one of MSDefine NATURAL,FLAT,SHARP,DOUBLE_FLAT,DOUBLE_SHARP constants.

SMStringToPitch(string name)

Extension and bugfix for builtin StringToPitch function.

• Allow pitches out of 0..127 bounds
• StringToPitch("B-1") gives the strange 71 result, SMStringToPitch("B-1") returns 11
• Handles double-sharp (## or x) and double-flat (bb)

Returns

int: May be out of 0..127 range.

int: Preferred accidental, one of AUTO, SHARP, FLAT... constants from MSDefine

EnterNumber(string text, number defaultValue, number minValue, number maxValue)

Ask the user to enter a number.

Use EnterString(...), and checks that the entered is a number within bounds. In case of error, ask again.

Return

number: or nil if user cancelled the choice.

EnterXY(string prompt, number minX, number maxX, number stepX, number factoryX, number currentX, number minY, number maxY, number stepY, number factoryY, number currentY, string displayValuesMask)

Ask to enter X,Y coordinates in a plotter with X and Y axis.

It's handy when you ask for 2 values, as X and Y offsets.

Returns

number: X, nil if user cancelled the dialog

number: Y, nil if user cancelled the dialog

Errors

if minX >= maxX or minY >= maxY

if factoryX or currentX are outside of [minX:maxX] range

if factoryY or currentY are outside of [minY:maxY] range

if factoryX and currentX, or factoryY and currentY are nil.

Example

 -- Create a new document with one staff, go to Page mode.
 -- This code moves first staff name position
 -- X between -50 and 50, Y between -30 and 30, steps are 1
 -- Negative Y go up, positive Y go down.
 -- Factory position is 0,0, current is 5,-24
   Include "SMUtils"
   x,y = EnterXY("Test XY",
    -50, 50, 1, 0, 5,
    -30, 30, 1, 0, -24,
    false, true, {FrontScore()},
    function(x,y,args)
      local staff = args[1].FirstStaff
      staff.TitleXOffset, staff.TitleYOffset = x, y
      Application.UpdateScores()
    end,
    "%x px, %y px" -- not mandatory, just show that unit is pixel (in 72 DPI)
  )

IsPowerOfTwo(number n)

Is n a number power of 2?

Return

boolean: true if n equals 1, 2, 4, 8, 16..., nil (for false) if not.

Error

if n is not a number

bin2int(string s, boolean signed)

Converts binary number (string containing only "0" and "1") to number.

Shortcut to tonumber(s, 2) with protection and no 32-bit limit

Return

int: 0 or positive integer

Error

if s is not a binary string

hex2int(string s, boolean signed)

Converts hexadecimal number (string containing 0-9a-fA-f) to number.

Shortcut to tonumber(s, 16) with protection and no 32-bit limit.

Return

int: 0 or positive integer

Error

if s is not an hexadecimal string

tohex(int n, int size, string separator)

Converts a number to hexadecimal string Shortcut to format("%x", n) with more options and no 32-bit limit

Return

string: string

Error

if n is not a number or size < 1 or separator is not a string.

tobin(int n, int size, string separator)

Converts a number to a binary string (containing only 0 and 1)

Return

string: string

Error

if n is not a number or size < 1 or separator is not a string.

BinNot(int a, int bits)

NOT bitwise operation MyrScript comes with BinAnd(...), BinOr(...), BinXor(...), BinShl(...), BinShr(...) but not the NOT bitwise operation.

Here it is!

Return

int: int

Example

 local a = 5 -- 0101
 print(bit_not(a, 4)) --> 10 (1010)