{"id":20813,"date":"2017-02-24T18:18:41","date_gmt":"2017-02-24T18:18:41","guid":{"rendered":"https:\/\/legacy.livecode.com\/?p=20813"},"modified":"2017-02-24T18:18:41","modified_gmt":"2017-02-24T18:18:41","slug":"the-livecode-script-profiler","status":"publish","type":"post","link":"https:\/\/legacy.livecode.com\/the-livecode-script-profiler\/","title":{"rendered":"The LiveCode Script Profiler"},"content":{"rendered":"

LiveCode\u2019s new Script Profiler, available in the LiveCode Business edition, can help you identify the most costly lines of code in a stack. \u00a0This can help you optimise your code by identifying inefficiencies.<\/p>\n

LiveCode\u2019s new Script Profiler, available in the LiveCode Business edition, can help you identify the most costly lines of code in a stack. \u00a0This can help you optimise your code by identifying inefficiencies.<\/p>\n

To use the Script Profiler you open a stack, start the profiler and use the stack. When each line of a script in the stack is executed the execution time will be recorded. When the profiler is stopped a report is presented.<\/p>\n

In this example we will look at an area that can often benefit from some optimisation, looping over an array. This example just uses a simple array with 10000 values in it. The code loops across the array and prints out all the values stored in the array.<\/p>\n

Open the stack you want to profile<\/h2>\n

Open the stack you want to profile, and ensure it is the topStack.<\/p>\n

The initial looping code is<\/p>\n

command arrayLoop \r\n<\/span>   local<\/span> tList\r\n\r\n<\/span>   put<\/span> empty<\/span> into<\/span> field<\/span> \"list\"\r\n<\/span>   repeat <\/span>with<\/span> x = <\/span>1<\/span> to<\/span> the<\/span> number<\/span> of<\/span> lines<\/span> in<\/span> the<\/span> keys<\/span> of<\/span> sTestArray\r\n<\/span>      put<\/span> line<\/span> x <\/span>of<\/span> the<\/span> keys<\/span> of<\/span> sTestArray <\/span>into<\/span> tKey\r\n<\/span>      put<\/span> sTestArray[tKey] & <\/span>return<\/span> after<\/span> tList\r\n<\/span>   end repeat\r\n\r\n<\/span>   put<\/span> tList <\/span>into<\/span> field<\/span> \"list\"\r\n<\/span>end arrayLoop<\/span><\/pre>\n
Start the Script Profiler<\/h2>\n
Choose ‘Start Profiling Scripts’ from the Development menu, this will begin profiling the topStack<\/a>.<\/p>\n
\"script_profiler1\"<\/p>\n
Use the Stack<\/h2>\n
Starting using the stack to begin the profile, when each line of a script in the stack is executed the execution time will be recorded.<\/p>\n
\"script_profiler2\"<\/p>\n
Stop the Script Profiler<\/h2>\n
\"script_profiler3\"<\/p>\n
To stop the Script Profiler select ‘Stop Profiling Scripts’ from the Development menu.<\/p>\n
The Script Profile Report<\/h2>\n
When the Script Profiler is stopped a report is shown.<\/p>\n
\"script_profiler4\"<\/p>\n
The report shows each line of script that was executed<\/p>\n
    \n
  • the line number<\/li>\n
  • number of times the line was called<\/li>\n
  • the time to execute the line<\/li>\n<\/ul>\n
    The total time in seconds is displayed at the bottom of the report.<\/p>\n
    Double clicking a line in the report will open the line of script in the Script Editor.<\/p>\n
    Optimisation<\/h1>\n
    Now we can see where all the time is going we know where we want to optimise our code.<\/p>\n
    In this example the vast majority\u00a0of the time is spent on the line<\/p>\n
    put<\/span> line<\/span> x <\/span>of<\/span> the<\/span> keys<\/span> of<\/span> sTestArray <\/span>into<\/span> tKey\r\n<\/span><\/pre>\n
    With a little thought we can see that we can change the form of the repeat loop we are using to something more efficient. We are only really interested in the values stored in the array, not the keys, so we can change the code to loop across the elements<\/strong> of the array.<\/p>\n
    command arrayLoop \r\n<\/span>   local<\/span> tList\r\n\r\n<\/span>   put<\/span> empty<\/span> into<\/span> field<\/span> \"list\"\r\n<\/span>   repeat <\/span>for<\/span> each<\/span> element<\/span> tValue <\/span>in<\/span> sTestArray\r\n<\/span>      put<\/span> tValue & <\/span>return<\/span> after<\/span> tList\r\n<\/span>   end repeat\r\n\r\n<\/span>   put<\/span> tList <\/span>into<\/span> field<\/span> \"list\"\r\n<\/span>end arrayLoop<\/span><\/pre>\n
    Now run the Script Profiler again and see how much faster the code is, 0.221 seconds rather than 10.318 seconds.<\/p>\n
    \"script_profiler5\"<\/p>\n
    Alternative Ways to Start and Stop the Script Profiler<\/h2>\n
    You can also start and stop the Script Profiler using the stack context menu, opened by ctrl\/right clicking on the stack, or via the stack context menu in the Project Browser.<\/p>\n
    \"script_profiler6\"\u00a0\"script_profiler7\"
    \nUsing the stack context menu<\/em><\/p>\n
    \"script_profiler8\"\"script_profiler9\"
    \nUsing the Project Browser<\/em><\/p>\n
    <\/h2>\n
    Available in LiveCode Business Edition 9.0.0 DP-5 onwards.<\/p>\n","protected":false},"excerpt":{"rendered":"
    LiveCode\u2019s new Script Profiler, available in the LiveCode Business edition, can help you identify the most costly lines of code in a stack. \u00a0This can help you optimise your code by identifying inefficiencies.<\/p>\n","protected":false},"author":5,"featured_media":20719,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"om_disable_all_campaigns":false,"footnotes":""},"categories":[45],"tags":[160,304,309],"class_list":["post-20813","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-blog","tag-business","tag-livecode-9","tag-script-profiler"],"acf":[],"_links":{"self":[{"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/posts\/20813","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/comments?post=20813"}],"version-history":[{"count":14,"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/posts\/20813\/revisions"}],"predecessor-version":[{"id":20873,"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/posts\/20813\/revisions\/20873"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/media\/20719"}],"wp:attachment":[{"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/media?parent=20813"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/categories?post=20813"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/legacy.livecode.com\/wp-json\/wp\/v2\/tags?post=20813"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}