IndexTopSummaryFunctions

Section Batch

Batch processing.

Examples


 --CREATOR: Sylvain
 --NAME: Change score title font
 --BATCH: Score
 -- assume this script is in Scripts > Notation > Score menu
 local n,f,s,c = ChooseFont("Title")
 if n then
    local fl, fs = FontFaceNumberToString(f)
    if BatchIsRecording("Score") == true then
      BatchAdd("Score", "Title font = "..n.." "..s.." "..fl,
        function(score)
          local sty = score.Title.Style
          sty.Font, sty.Face, sty.Size, sty.Color = %n, %fs, %s, %c
          score.Title.String = PurgeStringStyle(score.Title.String)
        end
      )
    elseif FrontScore() ~= nil then
      local sty = FrontScore().Title.Style
      sty.Font, sty.Face, sty.Size, sty.Color = n,fs,s,c
      FrontScore().Title.String = PurgeStringStyle(FrontScore().Title.String)
    end
 end


 -- Demonstrate batch processing
 BatchStartRecording("Score")
 -- Ask for the font
 Run("ChangeTitleFont")
 -- Ask for something else
 -- Include "another script that do crazy things on Score object"
 BatchStopRecording("Score")
 local folder = GetFolderName()
 if folder ~= nil then
     BrowseFolder(folder, "*.myr", function(fileName)
        local score = Load(fileName, false, false, false, false, false, false, false, false, 0)
        BatchExecute("Score", {score})
        return true -- continue browsing
      end
    )
 end
 BatchClear("Score")

Summary

Return typeFunction and summary
 BatchAdd(string batchName, string label, function func)
Stack a function for batch processing.
 BatchClear(string batchName)
Clear the batch stack, in case of cancellation or when all calls are done.
intBatchExecute(string batchName, Score score, object)
Execute the batch function stack on the objects in argument table.
 BatchIsRecording(string batchName)
Is the batch currently stacking?
 BatchStartRecording(string batchName)
Just set a flag that tells we are currently recording and stacking functions for further batch processing.
 BatchStopRecording(string batchName)
Cancel the flag that tells we are recording and stacking operations for batch processing, without clearing the stack.
tabletable_unique(table tab)
Remove duplicates from a table

Functions

BatchStartRecording(string batchName)

Just set a flag that tells we are currently recording and stacking functions for further batch processing.

ParameterTypeDefaultDescription
batchNamestring Batch name, by convention the type of object function will accept as argument ("Score", "Staff"...).

BatchStopRecording(string batchName)

Cancel the flag that tells we are recording and stacking operations for batch processing, without clearing the stack.

ParameterTypeDefaultDescription
batchNamestring Batch name, by convention the type of object function will accept as argument ("Score", "Staff"...).
Return
int Stack size

BatchIsRecording(string batchName)

Is the batch currently stacking?

If yes, then function must be stacked by BatchAdd, else performed directly.

ParameterTypeDefaultDescription
batchNamestring Batch name, by convention the type of object function will accept as argument ("Score", "Staff"...).
Return
bvool true if recording, nil (for false) if not
Example 


     if BatchIsRecording("Score") == true then
      BatchAdd("Score", "My action", MyFunction)
    else
      MyFunction(FrontScore())
    end

BatchAdd(string batchName, string label, function func)

Stack a function for batch processing.

ParameterTypeDefaultDescription
batchNamestring Batch name, by convention the type of object function will accept as argument ("Score", "Staff"...).
labelstring Just a label to show progression or report an error with context.
funcfunction The function that will be performed later, by BatchExecute.
  • If batchName is a conventional objet type ("Score", "Instrument"...) then the first argument must be of that type.
  • In most cases, a Score object is given as a second argument, the function can ignore it.
  • No return value is expected. In case of error, call throw("Error message", true), true means visual alert, false console only.

BatchClear(string batchName)

Clear the batch stack, in case of cancellation or when all calls are done.

ParameterTypeDefaultDescription
batchNamestring Batch name, by convention the type of object function will accept as argument ("Score", "Staff"...).

BatchExecute(string batchName, Score score, object)

Execute the batch function stack on the objects in argument table.

ParameterTypeDefaultDescription
batchNamestring Batch name, by convention the type of object function will accept as argument ("Score", "Staff"...).
scoreScore If needed, the score on which the batch will be processed
object nilThe object (Staff, Instrument...) that will be given as first argument to each function in the stack.
Return
int: Number of functions called.

table_unique(table tab)

Remove duplicates from a table

ParameterTypeDefaultDescription
tabtable tab
Return
table: table