It looks like the embed %AfterGeneratedApplication is a very popular embed these days.
\nWe already talked about it in the Template Tips #2 post where we compare it with the #AT(%ProgramEnd). Now we’ll compare #AT(%AfterGeneratedApplication) with #ATEND, and we’ll explain which of these is appropriate for a given task.<\/p>\n
Why do we compare #ATEND with #AT(%AfterGeneratedApplication) ?
\nBecause both of these are executed at the end of the code generation process (when we click on the Generate button).
\nSome 3rd Party Templates have the need to execute code that requires the App to be have been generated, and you’ll find they make use of #ATEND or #AT(%AfterGeneratedApplication).<\/p>\n
All of the templates support #ATEND, but we’ll focus on the #APPLICATION #ATEND embed.
\nThe #ATEND is comparable to a Destructor of a class, it is executed at the end of a templates code generation cycle, and the purpose is typically to execute some clean up code. When I mention clean up code I’m not talking about generating backups, creating extra files, or doing some extra\u00a0 processing, etc. I’m talking about cleaning up template symbol values. Any other processing should not be executed in the #ATEND.<\/p>\n
One of the reasons additional processing should not be executed in the #ATEND is that the #ATEND is similar to a Class Destructor, and that means the scope of the template is already ending, so just like in any other Class Destructor. you should not be creating new instances of anything at that point.<\/p>\n
Another reason, that is more related to the templates is the Embeditor. What does the Embeditor have to do with the #APPLICATION #ATEND?
\nWell if you inspect the #APPLICATION code closely you will see that there is one magic part that make the Embeditor work.<\/p>\n
I’m talking about this code:<\/p>\n
#IF (%EditProcedure)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0#! Special for editing embedded source in context<\/span>\n\u00a0 #CREATE(%EditFilename)<\/span>\n\u00a0 #FIND(%ModuleProcedure,%EditProcedure)<\/span>\n\u00a0 #FIX(%Procedure,%ModuleProcedure)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 #! Fix current procedure<\/span>\n\u00a0 #MESSAGE('Generating Module:\u00a0\u00a0\u00a0 ' & %Module,1) #! Post generation message<\/span>\n\u00a0 #MESSAGE('Generating Procedure: ' & %Procedure,2) #! Post generation message<\/span>\n\u00a0 #GENERATE(%Procedure)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 #! Generate procedure code<\/span>\n\u00a0 #COMMENT(60)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 #!Set comment alignment to column 60<\/span>\n\u00a0 #CLOSE<\/span>\n\u00a0 #ABORT #!Stop execution of any other code<\/span>\n#ENDIF<\/span><\/pre>\n\nYes, the Embeditor code is just the #GENERATION of the procedure with a little bit of magic.<\/p>\n
Because this code is executed in the #APPLICATION<\/span> section of the template we are expecting the #APPLICATION #ATEND to be executed.
\nActually everything would be executed if it was not for the #ABORT<\/span> at the end of the above code.
\nSo if you are using the #ATEND, you are not only adding code to the equivalence of a Class Destructor, but you are also adding code that will always be executed unless you check for the value of the %EditFilename symbol. If the value of %EditFilename is null then you can be sure that you are in regular code generation, and not in the Embeditor generation. This is a very important point.<\/p>\nWhere does the #AT(%AfterGeneratedApplication)<\/span> fit into all this code generation?
\nWell the #EMBED(%AfterGeneratedApplication) <\/span>is located at the end of the #APPLICATION template, it’s the last code to be generated before the #ATEND, but the big difference is that it only executes when we are generating the #APPLICATION during regular code generation. The execution of that embed will not happen on the Embeditor generation because of the #ABORT that we already mentioned.<\/p>\nThe conclusion, if you need to execute code at the end of the Application generation process, I always recommend the use of the #AT(%AfterGeneratedApplication)<\/span> instead of the #ATEND. And always try to use a PRIORITY, that will make other templates play nice with yours.<\/p>\n","protected":false},"excerpt":{"rendered":"It looks like the embed %AfterGeneratedApplication is a very popular embed these days. We already talked about it in the Template Tips #2 post where we compare it with the #AT(%ProgramEnd). Now we’ll compare #AT(%AfterGeneratedApplication) with #ATEND, and we’ll explain which of these is appropriate for a given task. Why do we compare #ATEND with … Continue reading Template Tips #3 – #ATEND vs #AT(%AfterGeneratedApplication)<\/span>