RootPolicy/RootPolicy-00-02-02/src/mainpage.h

Go to the documentation of this file.

//$Header: /bes/bes/BossCvs/RootPolicy/src/mainpage.h,v 1.1.1.1 2004/09/20 06:17:32 maqm Exp $
// (Special "header" just for doxygen)
 
/*! @mainpage  package RootPolicy
 
This package defines build policy for ROOT packages only. Requirements for building such a package:
 
- Some or all of the classes inherit from TObject, and the package  must "use" ROOT to access the header files.  
- As a part of the build process, it must run the ROOT utility rootcint, with dependence on all the header files. That is, if any header file is out of date, rootcint must be rerun seamlessly
- The build process must construct a .dll/.so that can be loaded by ROOT and a lib to describe it
- The path to the constructed binaries must be appended to LD_LIBRARY_PATH, for use by ROOT and Gaudi.
- The header files and libraries are made public for client packages. 
 
 
\section rootcint rootcint support
 
We define a makefile fragment, cmt/fragments/dorootcint_header so that individual ROOT packages can create a constituent to 
build the class member functions required by root. For Windows, this fragment also works for nmake.
 
For VisualC, a special version of dsp_library_header contains a section to build rootcint. The defines a "folder" called rootcint, 
but the guts to be filled a line at a time, with macros. This allows the header to be used for non-root packages, which can happen
since Glast packages cannot be used privately with CMT v1r10. 
 
Usage example: in the requirements file include <pre>
private
use RootPolicy
macro root_headers "../reconRootData/AcdRecon.h  ../reconRootData/LinkDef.h"
macro root_includes " -I\$(DIGIROOTDATA)" 
macro root_linkdef "../reconRootData/LinkDef.h"
apply_pattern root_package</pre>
 
Note the three macros: root_headers that specifiy a list relative to any subfolder,
the optional root_includes containing additional flags for the rootcint command line,
and root_linkdef, a source file for the make target. We are using the linkdef file for this.
 
Also note that the "use RootPolicy" should follow "use GlastPolicy" to override
the dsp library fragment, and should be private to avoid its use for a client package.
 
A technical note: both methods create "rootcint.cxx" files to be compiled and linked into the 
shareable library. For Visual Studio, this is put into the VisualC directory, while on Unix 
it is placed into the include directory.
 
dorootcint_header:
\include cmt/fragments/dorootcint_header
 
<hr>
 
<a href=../used_packages.html>Used packages</a>
  <hr>
  \section requirements requirements
  \include requirements
 
 
*/