HISE Logo Forum
    • Categories
    • Register
    • Login

    (Possible) Breaking change: local variables references inside nested function definitions

    Scheduled Pinned Locked Moved General Questions
    75 Posts 10 Posters 4.9k Views
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • DanHD
      DanH @Christoph Hart
      last edited by DanH

      @christoph-hart yes I changed 'local origin = hr;' to 'var origin = hr;' and the errors were gone.

      EDIT: It's all going wrong when trying to install an expansion now though :face_with_tears_of_joy:

      1 Reply Last reply Reply Quote 0
      • d.healeyD
        d.healey @DanH
        last edited by

        @danh said in (Possible) Breaking change: local variables references inside nested function definitions:

        if (hr.toString(2) == ".hr1")

        Magic number alert!!! You should use hr.toString(hr.OnlyExtension)

        Libre Wave - Freedom respecting instruments and effects
        My Patreon - HISE tutorials
        YouTube Channel - Public HISE tutorials

        DanHD 1 Reply Last reply Reply Quote 0
        • d.healeyD
          d.healey @DanH
          last edited by d.healey

          @danh said in (Possible) Breaking change: local variables references inside nested function definitions:

          ok so just:

          Yes, but it's no longer scoped now so you can change that comment ;)

          Also hr does exist at init so you can't assign the value there, you have to do that within your function like you were before.

          Libre Wave - Freedom respecting instruments and effects
          My Patreon - HISE tutorials
          YouTube Channel - Public HISE tutorials

          DanHD 1 Reply Last reply Reply Quote 0
          • DanHD
            DanH @d.healey
            last edited by

            @d-healey said in (Possible) Breaking change: local variables references inside nested function definitions:

            Also hr does exist at init so you can't assign the value there, you have to do that within your function like you were before.

            with 'var'?

            d.healeyD 1 Reply Last reply Reply Quote 0
            • d.healeyD
              d.healey @DanH
              last edited by

              @danh I'd say use a reg but if Christoph says a var is okay then var is ok. My point was you have reg origin = hr at the top of your script now, but hr doesn't exist until your FileSystem.browse call, so you can't assign it when you declare the origin variable at the top of your script you have to assign it after the call to browse just like you were with local origin = hr now you just put origin = hr. Or do what Christoph said.

              Libre Wave - Freedom respecting instruments and effects
              My Patreon - HISE tutorials
              YouTube Channel - Public HISE tutorials

              1 Reply Last reply Reply Quote 1
              • DanHD
                DanH @Christoph Hart
                last edited by

                This post is deleted!
                1 Reply Last reply Reply Quote 0
                • DanHD
                  DanH @d.healey
                  last edited by

                  @d-healey said in (Possible) Breaking change: local variables references inside nested function definitions:

                  Magic number alert!!! You should use hr.toString(hr.OnlyExtension)

                  Right, changing to the above makes the install process stop before the window appears allowing me to select the destination for the samples. So... select the .hr1 file and then nothing more...

                  d.healeyD 1 Reply Last reply Reply Quote 0
                  • d.healeyD
                    d.healey @DanH
                    last edited by

                    @danh Oo could be that the constant is bugged. I'm away from the computer for the next day so can't test, stick to your magic number for now :)

                    Libre Wave - Freedom respecting instruments and effects
                    My Patreon - HISE tutorials
                    YouTube Channel - Public HISE tutorials

                    1 Reply Last reply Reply Quote 0
                    • ustkU
                      ustk
                      last edited by

                      hr was already external, right? so why bother using another variable origin for the same thing in the first place?
                      It might be me, everyone around is telling me I need glasses... Arfff... 44... might be the time anyway...

                      d.healeyD 1 Reply Last reply Reply Quote 0
                      • d.healeyD
                        d.healey @ustk
                        last edited by

                        @ustk hr comes from the file browse call but the scope doesn't extend to the second browse call so it needs to be stored in a temporary variable

                        Libre Wave - Freedom respecting instruments and effects
                        My Patreon - HISE tutorials
                        YouTube Channel - Public HISE tutorials

                        1 Reply Last reply Reply Quote 0
                        • ustkU
                          ustk
                          last edited by ustk

                          Just to say that I updated my custom branch, and all my var changed to local in the current project that is dependent on this very custom branch.
                          It's not a big deal to change back everything though as I remember this fix. But in the case it can be fixed it could help other people not to have this surprise, without knowing where it comes from :)

                          orangeO 1 Reply Last reply Reply Quote 1
                          • ustkU
                            ustk
                            last edited by ustk

                            This post is deleted!
                            1 Reply Last reply Reply Quote 0
                            • orangeO
                              orange @ustk
                              last edited by orange

                              @ustk Same here. I've used tons of local variables in all of my projects. Now this shit comes...

                              alt text

                              develop Branch / XCode 13.1
                              macOS Monterey / M1 Max

                              d.healeyD 1 Reply Last reply Reply Quote 0
                              • d.healeyD
                                d.healey @orange
                                last edited by

                                @orange This problem was always there, it's just now you get a warning. It only applies to local variables in certain circumstances.

                                Libre Wave - Freedom respecting instruments and effects
                                My Patreon - HISE tutorials
                                YouTube Channel - Public HISE tutorials

                                orangeO 1 Reply Last reply Reply Quote 0
                                • orangeO
                                  orange @d.healey
                                  last edited by

                                  @d-healey said in (Possible) Breaking change: local variables references inside nested function definitions:

                                  @orange This problem was always there

                                  My previous projects can't be opened with the latest develop branch.
                                  But if I modify the local variables as var it works. So this issue is a new one.

                                  develop Branch / XCode 13.1
                                  macOS Monterey / M1 Max

                                  d.healeyD 1 Reply Last reply Reply Quote 0
                                  • d.healeyD
                                    d.healey @orange
                                    last edited by

                                    @orange

                                    But if I modify the local variables as var it works. So this issue is a new one.

                                    No it's an old issue, but now there is a new error so it might cause problems with opening old projects.

                                    You don't need to change all locals to var - in fact that is a really bad idea. You only need to change the ones that are in nested functions. And I recommend not changing them to var because that pollutes the scriptwide namespace, I think it's better to create a reg object at the top of each namespace that can be used to hold the values - should I make a video about this?

                                    Libre Wave - Freedom respecting instruments and effects
                                    My Patreon - HISE tutorials
                                    YouTube Channel - Public HISE tutorials

                                    orangeO 1 Reply Last reply Reply Quote 3
                                    • orangeO
                                      orange @d.healey
                                      last edited by

                                      @d-healey Ok I will try with reg thanks.

                                      So only modifying the places that the Hise gives the warnings is enough? Or even Hise doesn't give warnings, I should modify all nested functions?

                                      develop Branch / XCode 13.1
                                      macOS Monterey / M1 Max

                                      d.healeyD 1 Reply Last reply Reply Quote 0
                                      • d.healeyD
                                        d.healey @orange
                                        last edited by

                                        @orange

                                        Ok I will try with reg thanks.

                                        Just 1 reg at the top of the namespace.

                                        I should modify all nested functions

                                        Only nested functions (not inline functions) that are affected by this issue. The issue is that the variables go out of scope in certain circumstances. For example if you are calling something like Engine.showYesNoWindow() The callback function that you pass to that function will be triggered after any local variables have already been destroyed.

                                        So it's basically anywhere you are using a callback function. A few examples would be:

                                        Engine.showYesNoWindow()
                                        Server.downloadFile()
                                        File.extractZipFile()
                                        FileSystem.browse()
                                        FileSystem.browserForDirectory()

                                        Libre Wave - Freedom respecting instruments and effects
                                        My Patreon - HISE tutorials
                                        YouTube Channel - Public HISE tutorials

                                        ? 1 Reply Last reply Reply Quote 2
                                        • ?
                                          A Former User @d.healey
                                          last edited by A Former User

                                          I am just trying to understand the case about what to do here. I have a script like below and I am getting Cannot define local variables outside of inline functions or callbacks. error in Hise - the current develop branch.

                                          inline function onMYGENERICFUNCControl(component, value)
                                          {
                                                local myLocalOne = Engine.getSystemTime();  
                                                local myLocalTwo = Engine.getVersion();
                                                local myLocalThree = Engine.showYesNoWindow(); 
                                                  
                                              if(value)
                                              {
                                                // Execute a function
                                          
                                              }
                                          
                                          
                                              else
                                              {
                                                // Execute a function
                                          
                                              }
                                          };
                                          
                                          Content.getComponent("MYGENERICFUNC").setControlCallback(onMYGENERICFUNCControl);
                                          

                                          So Should I transform the local variables with namespace & reg combination like this? Is this an effective usage?

                                          namespace myNamespaceFunc
                                          {	
                                          	reg myLocalOne;
                                          	reg myLocalTwo;
                                          	reg myLocalThree;
                                          			
                                          	inline function onMYGENERICFUNCControl(component, value)
                                          	{	
                                          	    myLocalOne = Engine.getSystemTime();  
                                          	    myLocalTwo = Engine.getVersion();
                                          	    myLocalThree = Engine.showYesNoWindow(); 
                                          	        	
                                          	    if(value)
                                          	    {
                                          	      // Execute a function
                                          	
                                          	    }
                                          	
                                          		
                                          	    else
                                          	    {
                                          	      // Execute a function
                                          	
                                          	    }
                                          		
                                          	};
                                          		Content.getComponent("MYGENERICFUNC").setControlCallback(onMYGENERICFUNCControl);
                                          	
                                          };
                                          
                                          d.healeyD 1 Reply Last reply Reply Quote 0
                                          • d.healeyD
                                            d.healey @A Former User
                                            last edited by

                                            @Steve-Mohican You shouldn't be getting an error there, that is an inline function. Are you sure that is where the error is being generated?

                                            Libre Wave - Freedom respecting instruments and effects
                                            My Patreon - HISE tutorials
                                            YouTube Channel - Public HISE tutorials

                                            ? 1 Reply Last reply Reply Quote 0
                                            • First post
                                              Last post

                                            53

                                            Online

                                            1.7k

                                            Users

                                            11.7k

                                            Topics

                                            101.8k

                                            Posts