GetFilesInFolder(string folder, string mask, boolean recursive, boolean fullPath, boolean caseInsensitive, boolean ignoreDiacritics, table allowedExtensions, int maxNbOfResults, boolean includeFolders, boolean foldersOnly)

BrowseFolder(...) needs a callback function, and has a bug: here is a fixed and simplified version.

Return

table: File names: array of string, in alphabetic order

CreateFolders(string fullPath)

Create all folders that build a path.

The MyrScript CreateFolder(...) (without ending 's') function doesn't create subfolders. This function (with an ending 's') call as many times as needed the CreateFolder(...).
Another way to explain:
CreateFolders("C:/a/b") ensure that folder "a" is created in "C:", then next "b" is created in "a".
If fullPath already exist, nothing is done.

Return

Error message as string or 0 if no error.

FileReadLines(string path, int stringEncoding, int crlf, boolean errorIfNotFound)

Syntaxic sugar to read all lines of a file, and return a table of them.

Note:

• encoding is supposed to be UTF-8 BOM and lines terminated by Macintosh CR.
• Convenient for small files when full content have to been read and stored.

Return

table: Table of string, one item per line

Errors

if argument is not a string

if file can't be read

See

FileWriteLines

Example

 local lines = FileReadLines("/path/to/myConfigFile.txt")
 print(lines[1]) -- first line of the config file

FileWriteLines(string path, table lines, function formatFunc, int stringEncoding, int crlf)

Syntaxic sugar to writes a table of strings as lines in a file.

Collection and Map are also handled, and an optional formating function can transform lines before writing. Notes:

• The file is overwritten,
• Encoding is UTF-8 BOM and lines are terminated by Macintosh CR.

Errors

if arguments have bad type.

if file can't be written.

See

FileReadLines

Examples

 local lines = FileReadLines("/path/to/myConfigFile.txt")
 lines[1] = "0" -- change a value in the config file
 FileWriteLines("/path/to/myConfigFile.txt", lines)

 local map = Map:new("number", "string", SORT_ASCENDING)
 map:put(1, "one"); map:put(2, "two"); map:put(3, "three")
  FileWriteLines("/path/to/file/count.txt", map,
   function(key,value) return tostring(key).."="..strupper(value); end)
 )
 -- outputs 3 lines 1=ONE, 2=TWO and 3=THREE

ScriptReadVersion(string file)

Read the version of a script.

Look for the --VERSION: x.y in first 30 lines of source code.

Return

string: A version in the x.y.z or yyyyMMdd form (as source code), or nil if file doesn't exist or version not found.

CompareTextFiles(string file1, string file2)

Compare two text files, returns a diff-like format.

The diff format is used for data comparison, or, in development environnement, to compare old and new lines of source code.

Returns

table: Lines in approximate diff format:

• Added lines start with a + (plus)
• Removed lines start with a - (minus)
• Common lines (unchanged) start with a space.

int: Number of added lines

int: Number of removed lines

int: Number of unchanged lines

See

CompareTables

CompareStrings

LocateImageFile(string fileName)

Locate an image file in Harmony installation dir (system setting path).

This avoid embed image file in your script if they are copied from Harmony's documentation or cursors directory.

Return

string: The found file's full path, or nil if not found.

AddImagesDirectory(string path)

Add a directory where script can search for pictures.

Menus and other Component may include image (picture) which are searched by file name in some Harmony's subdirs, but not in relative paths from the current script. If your script embed images, it is good practice to call AddImagesDirectory(GetCurrentScript()) just after Include "SMUtils".

See

LocateImageFile

StructureReader.loadFile(string fileName)

Load a structured-text file.

Return

StructureReader: StructureReader

Error

if fileName can't be read