Trigger a class compilation

Question

Question

Maarten Van den... · Jul 18, 2017

Hi all,

I was wondering if there is any way to trigger the compilation of a class based on the compilation of another (unrelated) class. For example:

Class 1 = test.class

Class 2 = test.class.type.one

Class 3 = test.class.type.two

Every time class 2 or class 3 is compiled in Studio I would like to have class 1 automatically compiled as well.

The reason I need this is because class 1 has a method with CodeMode set to objectgenerator which generates some code based on what is found in classes 2 and 3.

Discussion (8)0

Log in or sign up to continue

Eduard Lebedyuk · Jul 18, 2017

You can use method generators:

ClassMethod OnCompile() [ CodeMode = objectgenerator ]
{
    do $system.OBJ.Compile("class")
    quit $$$OK
}

If method generator produces no code, then it would not be created, only ran at compile time.

1 0

score 0 · Answer 1 · 2017-07-18T08:03:21-04:00

Rubens Silva · Jul 18, 2017

I think what you want is:

Depends On and Compile After.

0 0

score 0 · Answer 2 · 2017-07-18T13:48:44-04:00

Thanks. This worked perfectly. Is there any list available with methods like this one? The Caché documentation does not contain any results for a search on OnCompile and even looking in the source code it's only used once in %SOAP.WebBase. How do you even know this exists?

score 0 · Answer 3 · 2017-07-18T13:53:26-04:00

It looks like this only checks if the dependant class exists and is properly compiled, but does not actually trigger a recompile of that class.

score 0 · Answer 4 · 2017-07-18T08:31:20-04:00

Use your own custom Projection, put it into your primary class, it runs every time you compile your primary class, in the code you can do whatever you want, e.g. compile other classes.

score 0 · Answer 5 · 2017-07-19T08:26:13-04:00

The name is not important. This method is an method generator, so it runs during compilation. But as it produces no code, the method does not get generated.

score 0 · Answer 6 · 2017-07-18T12:04:32-04:00

I believe the preferred option is the DependsOn class keyword. We use this often in DeepSee, because whenever you recompile the base class on which you base your cube, you should also recompile the cube class. So the cube class looks like this, for example:

Class DeepSee.Model.PatientsCube Extends %DeepSee.CubeDefinition [ DependsOn = DeepSee.Study.Patient ]

See http://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=ROBJ_class_dependson

score 0 · Answer 7 · 2017-07-18T14:35:03-04:00

True. But also, if you recompile a set of classes (e.g., by compiling a package), then we look through for dependencies like this and make sure to compile the independent class before the dependent one.